Jan 11, 2024

Making your first API call

Ready to make your first API call, but not sure about all the details? This article is for you.

To make your first API call, follow these steps:

1. Create your account

First, you'll need to create an account on this website.

2. Subscribe to a plan

Second, you'll need to subscribe to a plan. If you're not sure which one to buy, then this article can help you choose.

3. Find your API key

Fourth, you'll need to find your API key. To find your API key, log into the Developer Portal and click the the "My API keys" link on the left side of the page. When you're done, your screen should look like this:

Both the Primary API Key or Secondary API Key will work. Note that you can rotate your API keys on this screen as well!

4. Make your request

Finally, to authenticate an API request, craft the request URL using your API base URL and add a header to your request with X-BLOBR-KEY as the name and your API key as the value. For example, this curl statement would parse the name John Smith:

{% code-block language="bash" %}
BLOBR_API_KEY="XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
BLOBR_API_PLAN="enterprise"
BLOBR_API_BASE_URL="https://api.humangraphics.io/$BLOBR_API_PLAN"
curl -XPOST
-H "x-blobr-key: $BLOBR_API_KEY"
-H "content-type: application/json"
$BLOBR_API_BASE_URL/v1/humans/names/parse
-d '{"name":"John Smith"}'
{% end-code-block %}

5. Celebrate!

Congratulations on your first successful API request! 🎉