To use our API, you must first generate API credentials. These credentials (your API Key and Customer ID) are required for authentication and must be included in the headers of every API request to ensure security.

Generate API CredentialsCopied!

1. Log In
   Access your account on the magicplan Cloud. Ensure you have the necessary permissions to manage API credentials^*.

2. Navigate to the API & Integrations Page

   • Once logged in, locate the menu on the left-hand side.

   • Click on API & Integrations Page

3. Generate API Credentials

   • Follow the instructions on the page to generate your API Key and Customer ID.

   • ⚠️ Important: Safeguard these credentials; they will be required for all API interactions.

     • Never commit your API Key and Customer ID to a public repository.

     • Store them in environment variables or a secure secret management service.

Rotate API KeyCopied!

Rotating your API keys helps maintain security hygiene, ensuring that in case a key is ever compromised, it won’t pose a long-term risk. If you need to rotate your API keys:

1. Return to the API & Integrations Page on the magicplan Cloud.

2. Follow the prompts to generate a new key.

3. Update all your systems and integrations with the new key immediately to avoid disruptions.