Skip to content

Commit

Permalink
update InfoBip token and baseURL clarity
Browse files Browse the repository at this point in the history
  • Loading branch information
martyndavies committed Jul 17, 2023
1 parent 3949e39 commit 78ae508
Showing 1 changed file with 10 additions and 2 deletions.
12 changes: 10 additions & 2 deletions docs/api-examples/infobip.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -36,14 +36,18 @@ superface prepare https://www.infobip.com/docs/api/channels/sms/sms-messaging/ou

Once the documentation has been indexed, you will need to edit the `infobip.provider.json` that has been created to ensure that the correct API endpoint and security policy are used. The exact provider definition you need to use is below:

:::note INFOBIP BASE URL
InfoBip uses a personalized base URL for each customer. You will need to replace the `baseURL` value in the provider example below with your own. You can find yours on the [API documentation](https://www.infobip.com/docs/api) or [InfoBip Portal Homepage](https://portal.infobip.com/homepage/).
:::

```json title="infobip.provider.json"
{
"name": "infobip",
"defaultService": "default",
"services": [
{
"id": "default",
"baseUrl": "https://lz5x92.api.infobip.com"
"baseUrl": "<YOUR_INFOBIP_BASE_URL>"
}
],
"securitySchemes": [
Expand Down Expand Up @@ -78,7 +82,11 @@ superface map infobip sms-messaging/outbound-sms

### Add your API key

If you don't already have your Infobip API key in your environment, you can add it to your `.env` file as `INFOBIP_API_KEY="App <your-infobip-api-key>"`.
If you don't already have your Infobip API key in your environment, you can add it to your `.env` file.

:::note
You need to include the prefix `App` before your API key in your environment, this will ensure that Superface can meet the format required by InfoBip's API. For example, `INFOBIP_API_KEY="App <your-infobip-api-key>"`.
:::

### Set up your inputs

Expand Down

0 comments on commit 78ae508

Please sign in to comment.