Getting Started
Thank you for choosing {crud:api}, let's get you up and running as quickly as possible.
1. Sign up for a free account #
Click the "Sign up" button (top right), go on, it's just up there. You will require a Google account to use {crud:api}.
Note: each free account allows you to have a total of 500 database objects. Deleted items do not count towards your total. If you would like more, just contact us.
2. Create an API key #
{crud:api} uses token/bearer authentication. So we need to create a token: open the API Keys web app page and click "Create new key". This will generate a unique token for your account. You will see the full token in a dialog box. This is the only time you will see it, so copy it and keep it safe.
Note: you can create as many API keys as you wish. In this way you can grant/revoke access for specific devices or systems.
3. Send your first request #
Send a GET request to the {crud:api} API. In this example we're just probing the service.
curl -X GET https://crudapi.co.uk/api/v1/probe -H
"Content-Type: application/json" -H "Authorization:
Bearer YOUR_API_KEY"
Want to learn more? Check out the API docs
"Simplicity is the ultimate sophistication." - Leonardo da Vinci