Documentation
Log in Try for free
 Service status
Czech (Čeština) English (English)

Nothing found

Log in Try for free

API administration

Where do I manage my APIs?

Every interface is managed in the BulkGate Portal under Modules & APIs. The screen has two parts:

  • My APIs and Modules — cards for the interfaces you already created. Click a card to open its detail.
  • Discover our APIs and Modules — the catalogue of everything you can set up. Clicking a tile opens a window with the description, links to Website and Documentation, and the creation form.

The Modules & APIs screen with the My APIs and Modules and Discover our APIs and Modules parts

How do I create a new API?

  1. Click Modules & APIs in the menu
  2. Under Discover our APIs and Modules click the tile of the interface you want to set up
  3. Fill in the form in the window that opens
  4. Click Create API

The window with the form for creating an HTTP Simple API

The form differs by type of interface:

Type Fields in the form
HTTP APIs and token-based modules Name and Maximum API messages per day
Email > SMS and Low Level API Wallet and Name
Downloadable modules no form, just a Get module button
Note

For HTTP APIs the Maximum API messages per day field is required — until you fill it in, the Create API button stays disabled.

Creating an interface takes you to its detail. For Email > SMS the Email settings part holds the data you send to: Recipient, Short SMS subject and Long SMS Subject.

What is the Application ID?

The Application ID (APPLICATION_ID) is the unique number of your application. Together with the Application token (APPLICATION_TOKEN) it forms the API access credentials.

In the application detail it sits right under the application name in the form #39238, and again in the Login credentials part.

Where do I find the login credentials?

  1. Click Modules & APIs in the menu
  2. Under My APIs and Modules click the card of your application
  3. Stay on the Settings tab and find the Login credentials part

The Login credentials part of the application detail with the Application ID and token

It holds the Application ID and the list of tokens. For security the token is not shown straight away — you request it with Show token and confirm with your password. Add token and Regenerate token are protected the same way. The API tokens page covers the details.

How do I enable or disable an API?

  1. Open the application detail
  2. Below the application name sits a button with the current status — Active or Disabled
  3. Expand it and choose Enable or Disable
  4. Confirm in the Change status window
Warning

A disabled API rejects every request. An enabled one accepts every request.

How do I rename or delete an API?

The top-right corner of the detail holds a Rename button. It opens a window with a Name field; you confirm the change with Rename again.

The arrow next to it expands a menu containing Delete.

Caution

Deleting an application cannot be undone and removes every token belonging to it as well.

How do I set up delivery reports?

The application detail holds a Web hooks part on the Settings tab with the Delivery reports card. You put an address there for BulkGate to report the status of your sent messages to and to deliver incoming replies.

The whole procedure and every option is described on the Webhooks page.

Was this page helpful?
Ask AI Copied