Skip to main content

Security and authentication

You must be a verified user to make API requests. You can authorize against the API with an OAuth access token.

Topics covered in this section:

  • OAuth access token
  • SSL requirements

OAuth access token​

The Magnet Customer API supports OAuth authorization flows. Learn more.

In your requests, specify the access token in an Authorization header as follows:

Authorization: Bearer [access_token]

Example:

Authorization: Bearer gErypPlm4dOVgGRvA1ZzMH5MQ3nLo8bo

If you use curl to test different endpoints, you can use the following format:

curl https://[platform_name].magnetcustomer.com/api/contacts \
-H "Authorization: Bearer gErypPlm4dOVgGRvA1ZzMH5MQ3nLo8bo"

SSL requirements​

The Magnet Customer API an SSL-only API, regardless of how your account is configured.

All connections to the Magnet Customer API must support the TLS 1.2 protocol. Support for TLS 1.0 and 1.1 was removed in June 2018.

Connections to the API must also support the SNI extension to TLS.

If you connect to Magnet Customer through a client library, make sure it supports both TLS 1.2 and SNI.