{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"Authentication","description":"Guides and API reference for the DataSift (REISift) Core API and SiftMap API."},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"authentication","__idx":0},"children":["Authentication"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["All DataSift API access authenticates with a ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["REISift Open API key"]}," sent in the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Authorization"]}," header using the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Api-Key"]}," scheme:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"Authorization: Api-Key YOUR_OPEN_API_KEY\n"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Example:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"curl https://apiv2.reisift.io/api/internal/property/ \\\n  -H \"Authorization: Api-Key YOUR_OPEN_API_KEY\"\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["SiftMap uses the same ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Authorization: Api-Key"]}," format. See the ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/guides/siftmap-api"},"children":["SiftMap guide"]}," for its request URL and examples."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"getting-a-key","__idx":1},"children":["Getting a key"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Open API keys are available on plans above Professional. Generate and manage keys from your account's ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["integration settings"]}," in the REISift app."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"permissions-model","__idx":2},"children":["Permissions model"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Each key acts on behalf of the user it was issued for and inherits that user's permissions. A key issued for a standard team member can do what that member can do in the app; a key issued for an admin carries admin permissions. Issue keys at the lowest permission level that gets the job done, and issue separate keys for separate integrations so each can be revoked independently."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"key-hygiene","__idx":3},"children":["Key hygiene"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Send the key only in the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Authorization"]}," header, never in a URL query string."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Store it in an environment variable or a secrets manager, never in source code or a git repository."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Rotate or revoke a key immediately from the integration settings screen if it is ever exposed (pasted into a chat, committed, logged)."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["One integration, one key. When you retire an integration, revoke its key."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"recommended-headers","__idx":4},"children":["Recommended headers"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"Authorization: Api-Key YOUR_OPEN_API_KEY\nAccept: application/json\nContent-Type: application/json (on requests with a body)\n"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"failure-modes","__idx":5},"children":["Failure modes"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Response"},"children":["Response"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Meaning"},"children":["Meaning"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["401"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Missing or malformed Authorization header, or the key is invalid or revoked"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["403"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The key is valid but the user behind it lacks permission for this resource, or the plan does not include this capability"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["404"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Wrong path, or the resource exists but is outside this account's scope"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["429"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Rate limit exceeded - see ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/guides/rate-limits"},"children":["Rate limits"]}]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["There is no token refresh cycle and no expiry to manage. A key works until it is revoked or rotated."]}]},"headings":[{"value":"Authentication","id":"authentication","depth":1},{"value":"Getting a key","id":"getting-a-key","depth":2},{"value":"Permissions model","id":"permissions-model","depth":2},{"value":"Key hygiene","id":"key-hygiene","depth":2},{"value":"Recommended headers","id":"recommended-headers","depth":2},{"value":"Failure modes","id":"failure-modes","depth":2}],"frontmatter":{"seo":{"title":"Authentication"}},"lastModified":"2026-10-30T09:27:33.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/guides/authentication","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}