Why this guide exists?

This is for people that have made a package or mobile app that uses Codemagic product and is accessible for the public. We have made these guidelines in order to help you and us at the same time.

There may easily be situations when people think that you, the author of an application or package, work at Codemagic and Codemagic is responsible for maintaining said application or package. We should clearly communicate these expectations.

If you are interested in creating a third-party app using the Codemagic API, here are some guidelines to follow:

1. The Naming and Design of the App

To clearly distinguish that the app is a third party client app and an "unofficial" Codemagic application, make it clear. You should write that "this application is not affiliated with codemagic.io product" or "I do not work at Codemagic and this is an unofficial Codemagic application/package”.

It should be clear that the app is not affiliated with Codemagic, so please do not use the logo of Codemagic logo as the logo of your app. You may however use the Codemagic logo inside the app.

2. Use the Codemagic Press Kit

If you are creating marketing or promotional materials for your third-party app, use the Codemagic Press Kit. This includes Codemagic's logos, blog header images, and the vector library you can use to promote your app while following Codemagic brand guidelines.

If you found this page and are interested in getting started with the app here's what you can do!

Codemagic REST API allows you to integrate your CI/CD builds with other tools or to manage advanced workflow chains. You can also use it to create a third-party client app, providing greater flexibility and functionality to you or your team.

3. Familiarize Yourself with the Codemagic API

Before you start building your app, it's important to understand the Codemagic API well. Visit the Codemagic API documentation to learn about authentication, different endpoints, parameters, and responses. The Codemagic API can be accessed at https://api.codemagic.io.

4. Get an API Token

You require an API Token to authenticate your requests and access the different API endpoints. Your access token is available in the Codemagic UI under Teams > Personal Account > Integrations > Codemagic API > Show.

Note tokens are per user not per team.

Following these guidelines, you can create a high-quality third-party app for Codemagic. Good luck!