NetSuite Integration Guide
This section covers how to integrate external systems with NetSuite using modern authentication, API methods, and single sign-on.
Quick Navigation
| Section | Description |
|---|---|
| Integration Patterns | Push, Pull, Receive, Expose, File-based, Middleware |
| Authentication | OAuth 1.0 (TBA), OAuth 2.0, and SSO setup guides |
| REST API Reference | 98 record types with endpoints, fields, and examples |
Integration Methods
| Method | Use Case | Authentication |
|---|---|---|
| REST API (SuiteQL) | Query data, CRUD operations | OAuth 2.0 / TBA |
| RESTlets | Custom endpoints | OAuth 2.0 / TBA |
| SOAP Web Services | Legacy integrations | TBA |
| SuiteTalk REST | Standard record operations | OAuth 2.0 |
Authentication Options
AUTHENTICATION FLOW
─────────────────────────────────────────────────────────────────
┌─────────────────────┐
│ External System │
└──────────┬──────────┘
│
▼
┌─────────────────────┐
│ Auth Method? │
└──────────┬──────────┘
│
┌──────────────────────┼──────────────────────┐
│ │ │
▼ ▼ ▼
┌───────────────┐ ┌─────────────────┐ ┌─────────────────┐
│ OAuth 1.0 │ │ OAuth 2.0 │ │ Single │
│ (TBA) │ │ Client Creds │ │ Sign-On │
│ │ │ │ │ │
│ Simple Setup │ │ Server-to-Server│ │ User Login │
└───────┬───────┘ └────────┬────────┘ └────────┬────────┘
│ │ │
└─────────────────────┼──────────────────────┘
│
▼
┌─────────────────────┐
│ NetSuite REST API │
└─────────────────────┘
OAuth 1.0 Token-Based Authentication (TBA)
Traditional authentication method, easier to set up:
- Consumer Key/Secret - From Integration record
- Token ID/Secret - Per user/role access tokens
- No token expiry - Tokens remain valid until revoked
OAuth 2.0 (Modern)
Modern authentication supporting:
- Client Credentials Flow - For server-to-server integrations (requires certificate)
- Authorization Code Flow - For user-delegated access
Single Sign-On (SSO)
Federated identity for user login:
- Microsoft Entra ID - Azure Active Directory integration
- Google Workspace - Google identity provider
Getting Started
- Integration Patterns - Comprehensive guide to all integration patterns and scenarios
- OAuth 1.0 (TBA) Setup - Token-Based Authentication (simpler setup)
- OAuth 2.0 Setup - Modern OAuth 2.0 with certificates
- Single Sign-On (SSO) - Federated identity providers
Quick Links
| Topic | Description |
|---|---|
| Integration Patterns | |
| Push Out | NetSuite sends data to external systems |
| Pull In | NetSuite fetches data from external systems |
| Receive | External systems push data to NetSuite |
| Expose | External systems query NetSuite |
| File-Based | CSV/XML file exchanges |
| Middleware | Integration platforms (Boomi, Workato, etc.) |
| Authentication | |
| OAuth 1.0 (TBA) | Token-Based Authentication setup |
| OAuth 2.0 | OAuth 2.0 with Client Credentials |
| Microsoft Entra SSO | Azure AD single sign-on |
| Google SSO | Google Workspace single sign-on |
| REST API Reference | |
| API Introduction | Authentication, endpoints, best practices |
| Entities | Customer, Vendor, Employee, Contact |
| Sales Transactions | Sales Order, Invoice, Payment |
| Purchase Transactions | PO, Bill, Vendor Payment |
Choosing an Authentication Method
| Criteria | OAuth 1.0 (TBA) | OAuth 2.0 | SSO |
|---|---|---|---|
| Use Case | API integrations | API integrations | User login |
| Setup Complexity | Simple | Moderate | Moderate |
| Token Expiry | Never expires | Short-lived | Session-based |
| Best For | Long-running jobs | Modern M2M apps | Employee access |
| Security | Good | Better | Best (federated) |