Passa al contenuto principale

API Key

Crea e gestisci le chiavi API che autenticano le richieste a questa API.

📄️Cerca chiavi API

Returns all API keys associated with your account. Each entry includes the key ID, associated username, allowed operations, traffic type, and creation date, but the full key value is not returned for security reasons. Optionally filter the list by userId to see only keys created by or assigned to a specific user. Use this endpoint to audit which keys exist before creating new ones or revoking old ones. To look up a specific key by its raw string value, use GET /authentication/{value} instead. Returns 500 if an internal error occurs.

📄️Crea una chiave API

Creates a new API key for your account and returns the full key value in the response. IMPORTANT: The full key value is shown only once in this response. It cannot be retrieved again through any endpoint, so you must copy and store it securely immediately after creation. The key becomes active instantly and can be used to authenticate requests by passing it in the X-API-Key header. You can scope the key to specific operations (e.g. SMS, RCS, WHATSAPP) via the operations field in the request body, allowing you to create least-privilege keys for different integrations. If you lose a key, the only option is to delete it with DELETE /authentication/{id} and create a new one. Returns 400 if the request body is malformed or missing required fields. Returns 500 if an internal error occurs.

📄️Elimina una chiave API

Permanently revokes and deletes an API key. Revocation takes effect immediately: any subsequent API request that uses the deleted key in the X-API-Key header will receive a 401 Non autorizzato response. This action cannot be undone. If you delete a key by mistake, you must create a new one with POST /authentication and update all clients that were using the old key. Before deleting, ensure no active integrations or scheduled jobs depend on this key to avoid service interruptions. Returns 204 on success with no response body. Returns 404 if no key with the given ID exists or it does not belong to your account. Returns 500 if an internal error occurs.

📄️Cerca chiave API per valore

Looks up an API key by its raw string value and returns its metadata (ID, company, username, allowed operations, traffic type, and creation date). This is useful to verify that a key you have stored is still valid and to check which operations it is authorized for. The value path parameter must be the complete API key string exactly as it was returned when the key was created. Returns 404 if no key matches the provided value, which could mean the key was deleted or never existed. Returns 500 if an internal error occurs.