To receive API credentials, you must submit a request. The request process depends on whether you are a client, a partner requesting access to MJ Platform’s sandbox environment, or a partner requesting access to a client’s live site.
This article covers each request process.
For clients integrating with Weedmaps or Sprout
Requesting an API key for an integration to your live site
1. Apply for an account on our Partners Portal
Note: If you already have an account on our Partners Portal, you can skip this step.
Navigate to our Partners Portal at partners.mjfreeway.com and click Apply for Access.
On the Apply for Access page, enter your information in the provided fields, and select the APIs you want to access, then click Apply.
You will receive a verification email from the site. Follow the steps in the email to verify your email address and complete your account application.
2. Send our team a request email
Send an email to our Akerna API team with the following:
Subject line: Client API Key Request
Example/suggested message:
“Hello, this is [your organization name]. We are requesting an API key to integrate with [integrator name]. Please let us know when the API key is ready. Thank you.”
3. Wait for a response email
Once the Akerna API team has approved your application, they will generate a new API key, place it into your Partner Portal, and then send you a confirmation email.
4. Retrieve your API key
Once you receive the confirmation email, log in to the Partners Portal at partners.mjfreeway.com
When you log in, your API key is displayed with a relevant description.
Use the buttons to view
and copy
the API key.
For clients integrating with other partners
Requesting an API key for an integration to your live site
Send an email to us with the request as follows:
CC: (the partner)
Subject line: Client API Key Request
Example/suggested message:
“Hello, this is [your organization name]. We are requesting an API key to integrate with [integrator name]. Please let us know when the API key is ready. Thank you.”
The partner will then take it from there to get you set up.
For partners that got a request from a client
Note: The sections below are for non-Weedmaps and non-Sprout integrators. Weedmaps and Sprout need to use clients' API credentials in order to integrate. For Weedmaps, the client should register in the Partners Portal and make the request by following the steps in the section above.
Requesting an API key for the MJ Platform sandbox environment
1. Apply for an account on our Partners Portal
Note: Our team can only create one sandbox account for your organization. If your organization already has an account on the Partners Portal with an API key for the sandbox environment, you must use that key.
Navigate to our Partners Portal at partners.mjfreeway.com and click Apply for Access.
On the Apply for Access page, enter your information in the provided fields, and select the APIs you want to access, then click Apply.
You will receive a verification email from the site. Follow the steps in the email to verify your email address and complete your account application.
2. Send our team a request email
Send an email to our Akerna API team with the following:
Subject line: Sandbox API Key Request
Example/suggested message:
“Hello, we are requesting an API key for an MJ Platform sandbox environment. Please let us know when the API key is ready. Thank you.”
3. Wait for a response email
Once the Akerna API team has approved your application, they will generate a new API key, place it into your Partner Portal, and then send you a confirmation email.
4. Retrieve your API key
Once you receive the confirmation email, log in to the Partners Portal at partners.mjfreeway.com
When you log in, your API key is displayed with a relevant description.
Use the buttons to view
and copy
the API key.
Requesting an API key for a client’s live site
1. Apply for an account on our Partners Portal
Note: If you already have an account on our Partners Portal, you can skip this step.
Navigate to our Partners Portal at partners.mjfreeway.com and click Apply for Access.
On the Apply for Access page, enter your information in the provided fields, and select the APIs you want to access, then click Apply.
You will receive a verification email from the site. Follow the steps in the email to verify your email address and complete your account application.
2. Send our team a request email with the client Cc’d
We require approval from the client whose site you are requesting access to before we can approve your request.
To request approval, send an email to our Akerna API team with the following:
Cc: [email address of the client whose site you want API access to]
Subject line: Partner API Key Request
Example/suggested message:
“Hello, we are requesting a new API key to complete our integration with MJ Platform for our client’s live site. Our client has been Cc’d and will reply to this email to confirm their approval. Please let us know when the API key is ready. Thank you.”
3. Wait for a response email
Once the client has confirmed their approval, our API team can review the request. Upon approval, they will generate a new API key, place it into your Partner Portal, and then send you a confirmation email.
4. Retrieve your API key
Once you receive the confirmation email, log in to the Partners Portal at partners.mjfreeway.com
When you log in, your API key is displayed with a relevant description.
Use the buttons to view
and copy
the API key.
