Public API

The Public API is the application interface that lets you use Netsipp programmatically from your own software. Create an API user and send your requests with the key you receive to manage your accounts, contacts, calls and reports from outside.

Creating an API User

• Open the Organization Settings screen from the left menu and switch to the API Users tab.
• Click the Add API User button.
• Enter a name; you can optionally set an expiry date and choose whether the user is active.
• When you save, an API Key is generated for you.

Note: The API Key is shown only once, at the moment it is created. Take it with Copy and store it somewhere safe; it cannot be displayed again, and if you lose it you have to create a new user.

Sending Requests

• Send your requests to https://api.netsipp.com.
• Carry your identity in the Authorization header on every request: Authorization: Bearer <API Key>
• To verify your connection, use the GET https://api.netsipp.com/v1/me call; this endpoint returns which API user the key belongs to.

Tip: With the test tool on the API Users tab you can try the /v1/me call right after saving your key and see that your connection works.

Endpoint Documentation

You can reach the detailed documentation of every endpoint you can use at https://docs.netsipp.com/api. The related API headings are:

• Accounts, Users, Contacts and Projects
• Conversations, Call Scripts and Breaks
• CRM, Quick Replies and Ticket
• Reports and Auto Dialer

Under each heading you will find the address of the relevant endpoint, the parameters to send and sample requests and responses.

Note: The Public API is different from the session or application permission flow used to log in to the portal; in this API the identity is always provided with the API Key.