Management of card payment credentials under the ruling of PCI/DSS.
Guardian API (EAP)
https://{cluster_id}.on-hellgate.cloud/
API Keys
Management of API keys for service access.
The capabilities an API keys has access to can be scoped to these areas:
- API Keys
admin:api-keys:create
admin:api-keys:read
admin:api-keys:update
admin:api-keys:delete
- Webhooks
admin:webhooks:create
admin:webhooks:read
admin:webhooks:delete
- PCI Tokens
pci:tokens:create
pci:tokens:read
pci:tokens:update
pci:tokens:delete
pci:tokens:forward
- Network Tokens
network:tokens:create
network:tokens:read
network:tokens:delete
network:tokens:use
- Metadata Inquiries
metadata:inquiry:create
How many seconds after creation the API key expires automatically.
A list of scopes that the API key will have access to.
- Managed instance of Guardian CPA
https://my-cluster-id.on-hellgate.cloud/api/admin/api-keys
- curl
- Java
- Node.js
- Ruby
- Go
- Python
curl -i -X POST \
https://my-cluster-id.on-hellgate.cloud/api/admin/api-keys \
-H 'Content-Type: application/json' \
-H 'x-api-key: YOUR_API_KEY_HERE' \
-H 'x-idempotency-key: order_12345_retry_001' \
-d '{
"expires_in": 3600,
"scopes": [
"admin:api-keys:create",
"admin:api-keys:update"
]
}'
Success response
The generated API key value. It will only be returned once with this response.
A list of scopes that the API key will have access to.
{ "id": "123e4567-e89b-12d3-a456-426614174000", "created_at": "2023-10-01T10:00:00Z", "expires_at": "2023-10-01T11:00:00Z", "key_value": "key_1234567890ABCDEF", "scopes": [ "admin:api-keys:create", "admin:api-keys:update" ] }
- Managed instance of Guardian CPA
https://my-cluster-id.on-hellgate.cloud/api/admin/api-keys
- curl
- Java
- Node.js
- Ruby
- Go
- Python
curl -i -X GET \
'https://my-cluster-id.on-hellgate.cloud/api/admin/api-keys?after=497f6eca-6276-4993-bfeb-53cbbbba6f08&limit=20' \
-H 'x-api-key: YOUR_API_KEY_HERE'
{ "data": [ { … } ], "links": { "next": "https://my-cluster-id.on-hellgate.cloud/admin/api-keys?after=123e4567-e89b-12d3-a456-426614174000&limit=20" } }
- Managed instance of Guardian CPA
https://my-cluster-id.on-hellgate.cloud/api/admin/api-keys/{id}
- curl
- Java
- Node.js
- Ruby
- Go
- Python
curl -i -X GET \
'https://my-cluster-id.on-hellgate.cloud/api/admin/api-keys/{id}' \
-H 'x-api-key: YOUR_API_KEY_HERE'
Success response
A list of scopes that the API key will have access to.
{ "id": "123e4567-e89b-12d3-a456-426614174000", "created_at": "2023-10-01T12:00:00Z", "masked_key_value": "key_123xxxx", "scopes": [ "admin:api-keys:create", "admin:api-keys:update" ] }
Webhooks
Management of webhooks for event notifications.
Guardian uses tiny events as notification payload. They give you the context of what happened and you can use this information to fetch more details via our API.
Please find the documentation about the callback on the endpoint that registers the webhook.