Authentication
Updated 2 weeks ago
Gratona's REST API accepts an API key or a Passport bearer token on protected admin endpoints.
Create an API key
In your user menu, open Organization Settings and select Developer Settings. Give the key a name, choose an optional expiration, and select Generate API Key. Copy and store the full key when it is shown; you cannot view it again later.
Send the key in the X-HYS-API-Key header, for example:
X-HYS-API-Key: hys_your_key_here
If you use a Passport access token instead, send Authorization: Bearer <token>. Access is limited to the credential's organization, scopes, and the admin's permissions.
Public endpoints and donor, recipient, or participant portal endpoints can have different authentication requirements. Check the operation before sending a request.
See the API Reference authentication guide for a cURL example, supported API versions, and endpoint-specific requirements.