Apps and API keys

Create an app for each integration, give it roles, and it gets an API key for the environment you created it in. Rotate a key to issue a replacement, or pause it and resume it later. The app can only do what its roles allow.

How it works

Every integration with the ShipGenius API runs as an app. Create one in Settings, under Developer, Apps. Give it a name and the roles it needs. The app gets an API key for the environment you created it in, production or sandbox, and the key can only do what those roles allow.

Managing keys

The app's Access section shows its roles and its keys. Reveal a key to copy it.

Rotate Key issues a replacement. Choose when the old key expires, right away or after an hour, a day, a week or four weeks, so both keys work while you switch over.
Pause stops a key from working until you Resume it.

Webhooks

Each app can also send webhooks to your systems. Add them in the app's Webhooks section.

Read more in API keys and connected apps.