# Quick start guide
source: https://developer.mastercard.com/carbon-calculator-china/documentation/quick-start-guide/index.md

## Overview {#overview}

The **Quick start guide** leads you through the process of onboarding and being able to consume the carbon calculator services in different environments.
> **You can follow this guide to learn:**
>
> * How to create a project for the service.
> * How Mastercard Developers approach authentication.
> * How to generate your credentials and API customer.
> * How to get access to Sandbox and Production.

## Pre-requisites {#pre-requisites}

### File exchange onboarding process {#file-exchange-onboarding-process}

* Before creating your project on Mastercard Developers, you must first register on Mastercard Connect™ and onboard on Mastercard's NGFT and GFT file exchange process.
* The Customer Implementation Service (CIS) ensures that you request the right user roles to onboard to the File Exchange platform and transfer files.
* Once you have access, the CIS will assist you to onboard and guide you throughout the entire process until the file transfer is complete.  

Note:   
For more details on the steps to:

* Register on Mastercard Connect, refer to the [Mastercard Connect Onboarding Guide](https://trc-techresource.mastercard.com/r/bundle/m_mic_onboard_en-us/page/d/en-US/hjv8818197982552.html) on TRC.
* Onboard customers on NGFT and GFT, refer to the [Tutorials and Guides](https://developer.mastercard.com/carbon-calculator-china/documentation/tutorials/index.md) section.

### Mandatory values {#mandatory-values}

Following are the mandatory values that you need to provide at the time of project creation in the Sandbox.

* [Customer Name](https://developer.mastercard.com/carbon-calculator-china/documentation/terminologies/index.md#customer-name)
* [Sender ID](https://developer.mastercard.com/carbon-calculator-china/documentation/terminologies/index.md#customer-logical-name) or [Customer Logical Name](https://developer.mastercard.com/carbon-calculator-china/documentation/terminologies/index.md#customer-logical-name)

Note: The [Customer ID (CID)](https://developer.mastercard.com/carbon-calculator-china/documentation/terminologies/index.md#customer-id-cid) is mandatory to access Carbon Calculator.  

Ensure:

* To use a **valid CID** assigned by Mastercard, which remains the same across all Mastercard systems.
* That same BINs do not map with multiple CIDs.

## Accessing APIs on Mastercard Developers {#accessing-apis-on-mastercard-developers}

To access the APIs on Mastercard Developers:

1. Navigate to [Mastercard Developers](https://developer.mastercard.com/) and click sign-up and create an account.
2. Activate your account by opening the link sent to your email address, and log in.
3. Request access, if needed. The APIs with a **lock icon** require permission to view their documentation and create a project.
4. To gain access to these services, submit an access request form. Once submitted, you will receive an email confirmation approving or denying your access.

## Generate credentials and create a sandbox project {#generate-credentials-and-create-a-sandbox-project}

To generate your Sandbox and Production credentials, you must create a new Mastercard Developers project.

Follow these steps to create a Sandbox Carbon Calculator Project:

1. To begin with, select the [My Projects](https://developer.mastercard.com/dashboard) option in the menu to navigate to your dashboard.
2. Create a new project by selecting the **Create New Project** button, in the upper right portion of the screen as shown in the screenshot below. ![Create Project](https://static.developer.mastercard.com/content/carbon-calculator-china/uploads/create_project.png)
3. In the **Project Details** page, enter a descriptive name for your project.
4. Select:
   * **Yes** : to create this project on behalf of a customer.  
     Enter your **Client company name** , **Client company ID** , and **Client legal business address** before proceeding.
   * **No** : if you are not. Note: Check **Yes** if you are creating an API integration project for a customer. For example, you could be an integrator, a processor, or a service provider and the customer could be a merchant, issuer, or acquirer.
5. In the **Select at least one API** field, select **Carbon Calculator**.
6. Select **Proceed** to enter the service details.
7. In the **Service details** page:  
   a. Enter your [Customer Name](https://developer.mastercard.com/carbon-calculator-china/documentation/terminologies/index.md#customer-name).  
   b. Enter your [CID](https://developer.mastercard.com/carbon-calculator-china/documentation/terminologies/index.md#customer-id-cid).  
   c. Enter the (comma-separated) **BIN** ranges you want to use for the Carbon Calculator API.  
   For example, 534403, 518145, 518152, 5403, 5424.  
   d. Enter your [Sender ID](https://developer.mastercard.com/carbon-calculator-china/documentation/terminologies/index.md#customer-logical-name).  
   e. Enter your **Cardholder Base** . This is the total volume of cardholders to whom the cards are issued. You can contact your Mastercard representative or send a request to [carboncalculator@mastercard.com](mailto:carboncalculator@mastercard.com) to update this later as required.  
8. Select **Proceed** to create your project credentials.
9. In the **Project credentials** page, enter your **key alias** and **keystore password** . Note:   
   Creating a project in Mastercard Developers is required to access the documentation for the file‑based scoring flow. However, the Sandbox and Production keys generated while creating the project will not be usable, since the carbon scoring workflow operates entirely through file-based transfer rather than APIs.
10. Select **Proceed** to create additional credentials for your project. You will see a note if there are no actions needed from you here.
11. Select **Create Project** to create your project.
12. After the project creation is successful, the sandbox .p12 access credentials are available to download as shown in the screenshot. ![Dowload-sandbox-keys](https://static.developer.mastercard.com/content/carbon-calculator-china/uploads/generating-keys.avif)
13. Select the **Download key file** button to download a zip file containing the .p12 file required for OAuth authentication in the Sandbox.
14. After you complete this flow, select **Open project**. The project summary page opens.
15. From the **Summary** page take note of your:  
    a. Sandbox and Production status (Ready/Not Requested)  
    b. Sandbox and Production credentials, that is, authentication consumer key and customer encryption key fingerprint. ![Project Page](https://static.developer.mastercard.com/content/carbon-calculator-china/uploads/project_page.png)
16. Once your onboarding process is completed, you will be informed through an email.

## Go-live {#go-live}

### Pre-requisites {#pre-requisites-1}

Before requesting production access, you need to provide the commercial countries for your product:

1. Select the **Get Started** link from the **Summary** page.

   ![Commercial Countries](https://static.developer.mastercard.com/content/carbon-calculator-china/uploads/provide-countries.png)
2. From the **Provide commercial countries** drop-down list, select **China**.

3. Select **Submit**.

After submitting you will need to wait for approval. On approval, you receive an email and 'Ready' status for your product to request for production access.

### Request production access {#request-production-access}

Follow these steps, when you are ready to move your project to production:

1. Click the **Request Production Access** button in the Production section of the screen. ![Req Prod Acc](https://static.developer.mastercard.com/content/carbon-calculator-china/uploads/request_production_access.png)
2. Provide the required **Service details** as explained in creating a Sandbox project.
3. Enter a descriptive name for the key, which identifies its purpose and environment, in the **Key Alias** field.
4. Enter a password used to encrypt the keys that the customer will receive, in the **Keystore Password** field. ![Encrypt Keys Pwd](https://static.developer.mastercard.com/content/carbon-calculator-china/uploads/production_keyalias.png) Note:   
   Creating a project in Mastercard Developers is required to access the documentation for the file‑based scoring flow. However, the Sandbox and Production keys generated while creating the project will not be usable, since the carbon scoring workflow operates entirely through file-based transfer rather than APIs.
5. Proceed to generate your additional credentials (such as Mastercard encryption keys and customer encryption keys) by selecting **Update Project** . ![Generate Addn Cred](https://static.developer.mastercard.com/content/carbon-calculator-china/uploads/additional_credential.png)
6. Production keys are generated and your project updated. Confirm and download your Production keys. ![Download Prod Keys](https://static.developer.mastercard.com/content/carbon-calculator-china/uploads/production_download_keys.png)
7. Once you complete this process, the Mastercard API Support Team will review and approve your request for production access.
8. You will receive an email from Mastercard Developers to your registered email address, depending upon the outcome of the review.

Note: Production credentials are generated instantaneously, but they still need to be approved for Production environment access before you can go live. Once your production access request is reviewed, you will receive a notification confirming whether your access is approved or denied.

## Next steps {#next-steps}

Now that you have access to the service, proceed to the [File transfer applications](https://developer.mastercard.com/carbon-calculator-china/documentation/file-based-scoring-protocols/index.md) section to learn about the different file transfer applications used by Carbon Calculator.