Your first MyCRM integration
Go from an integration idea to a successful request with a clear understanding of access and a small first example.
- Get access. Describe what your application needs to do, confirm its access and learn how OAuth 2.0 protects the connection.
- Make your first request. Exchange client credentials for an access token and call a permitted endpoint.
- Learn the response format. Understand resources, relationships and the JSON:API envelope.
- Update information in MyCRM. Find the correct adviser contact ID, send the
UserIdheader and understand permission errors. - Build for production. Plan token reuse, request costs, retries and reconciliation.
Prefer to explore without writing code? Try Postman using the collection setup guide. If you work in C#, explore the sample client to see authentication and common workflows in an interactive console application.
Keep these values together
| Value | Where it comes from |
|---|---|
| Authentication URL | Supplied with your credentials; use the complete token URL |
| API base URL | Supplied for your environment; examples append /jsonapi/... |
| Client ID and secret | Issued for the interacting application |
| Scopes | Capabilities approved for the application |
| Adviser contact ID | Supplied with access or shown in the API settings |
Examples use fictional records. Replace placeholders with the values issued for your own integration.