Sign up process

In this section, we walk through the steps to sign up and join the Bill.com developer program.

Sandbox sign up process

You can test with the Bill.com API in the sandbox environment. Begin with setting up your Bill.com sandbox developer account.

  1. Reach out to your Bill.com sales representative or account manager to begin the sign up process.
  2. Your contact reviews the request and reaches out to you to discuss your objectives. In addition, they walk you through creating your Bill.com sandbox developer account.
  3. After creating your account, set your password and sign in to your Bill.com sandbox web app. This account also represents your Bill.com organization in the sandbox environment.
  4. The Bill.com team provisions API access to your account. In a separate email, we send you the required information for your API login.

Sign in credentials

Description

Username

Your username is the email address used to sign in to your Bill.com sandbox developer account.

Password

Your password is used to sign in to your Bill.com sandbox developer account.

Organization ID

Your Bill.com sandbox developer account represents your organization in Bill.com. The organization ID is a unique alphanumeric value that begins with 008.

Developer key

Your developer key is used to uniquely identify your developer account in your API requests.

Sandbox API base URL

https://api-sandbox.bill.com/api/v2/

Sandbox sign in

Sign in to your Bill.com sandbox developer account with the /Login.json API endpoint. The required fields for signing in are userName, password, orgId, and devKey.

Set the required values in the cURL command example and run the command in the Mac Terminal, Windows Command Prompt, or your choice of command line interface.

curl --request POST \
--url 'https://api-sandbox.bill.com/api/v2/Login.json' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data 'userName={username}' \
--data 'password={password}' \
--data 'orgId={organization_id}' \
--data 'devKey={developer_key}'

In the response, your API session is created and a sessionId is generated. Use the sessionId in all subsequent API calls to confirm that you are in a signed in session. See the Login API for more information.

Retrieve organization ID with the API

You can retrieve the organization ID (orgId) linked to your sandbox account with /ListOrgs.json. Set the required values in the cURL command example and run the command in your choice of command line system.

curl --request POST \
--url 'https://api-sandbox.bill.com/api/v2/ListOrgs.json' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data 'devKey={developer_key}' \
--data 'userName={email_address}' \
--data 'password={password}'

In the response, the orgId and orgName values are retrieved. See Retrieve organizations for the current user for more information.

Production sign up process

Your go-live application is available to your customers in the production environment.

As you continue to build and test your application in the sandbox environment, reach out to your Bill.com account manager and set up your production account when you are ready to build your application in the production environment.


Did this page help you?