Obtain Authentication and Authorization Keys

All requests to Inbenta API endpoints will be authenticated and authorized.
In order to start using our APIs you must first contact Inbenta so we can provide you with your own API Key, API Secret and Domain Key:

• The API Key will grant you access to the APIs.
• The Secret allows the request to access your instance's data.
• The Domain Key allows the request to access your instance's data, but only for requests coming from the browser (front-side integrations) and from a limited set of domains.

Use the access token

You need a valid access token to use Inbenta APIs. Follow the steps listed in the Authorization section to set up your page with your token and refresh it. Once you obtain the access token, you must append it to every request inside the Authorization header, with the format

Bearer <your_access_token>.

Get the API URL

The Inbenta API's base URLs depend on the project so we can offer a world wide service and allow service auto-escalation. This base URL may change over time and it should not be persistently stored or cached. Instead, you should get it every time you obtain a new valid access token.

To get the current API URL for your project, there must be a request to https://api.inbenta.io/v1/apis like this:

curl -X GET \

    https://api.inbenta.io/v1/apis \

    -H 'authorization: Bearer <your_access_token>' \

    -H 'x-inbenta-key: <your_API_Key>'

This request will return a response like this:

{

      "apis": {

            "nl-interpreter": "https://endpoint.inbenta.example/prod/Interpretations"

            }

}

Use this response to pick the URL for the product that you want to use.

Do not perform this request after each API call! You would quickly exceed your rate limits.

Specify the version

Once you have picked the appropriate product URL for your implementation, remember to specify the version of the API.

You specify the version at the end of the URL with v + {version}

Examples:

The URL for the current latest version of each product API looks like this:

"https://endpoint.inbenta.example/prod/v1/interpretations"