FAQ
Overview
FAQ
Getting Started
What’s the difference between a Sandbox and Production environment?
A Sandbox (also known as a Test) environment establishes credentials to a Sandbox environment for all API Products in your Sandbox App. A Production environment establishes credentials for all API Products in your Production App.
How do I access a Sandbox API Product?
You first need to create a Sandbox App (also known as Test App) on MyApps of the Marketplace. Select Add New App, set the environment to “Sandbox”, choose the Test API Product(s) you would like to access, then select Add App, to create your App. After the request is authorized, the consumer key and secret credentials will provide you with access to the Test API Product(s).
How do I obtain user credentials?
Users must be added to the system to work with Lumen APIs. Any user can register on the Lumen API Marketplace by selecting the Register link in the portal menu.
How do I create a User Account?
Open the Portal home page and fill out the Register form.
How do I register an application?
You can register multiple applications under the same user account using the MyApps page through the portal.
How do I obtain a Consumer Key and Secret?
When an application is added on the MyApps page, a Consumer Key and Secret will be assigned. After the application is approved for access to the API, the Consumer Key and Secret will be activated. Once activated, your application can call the Lumen Authorization Server to request an access token.
How do I sample an API?
Some of our API Products will provide the ability to try the function with mock data. You can find the “try it” capability in the API documentation. If you are ready to start developing and want to test the API, set up an application to get access to the API Product.
How do I access a Production API?
You first need to create a Production App on MyApps of the Marketplace. Select Add New App, set the environment to “Production”, choose the API Product(s) you would like to access, then select Add App to create your App. After the request is authorized, the consumer key and secret credentials will provide you with access to the Production API Product(s).
Getting Started
What’s the difference between a Sandbox and Production environment?
A Sandbox (also known as a Test) environment establishes credentials to a Sandbox environment for all API Products in your Sandbox App. A Production environment establishes credentials for all API Products in your Production App.
How do I access a Sandbox API Product?
You first need to create a Sandbox App (also known as Test App) on MyApps of the Marketplace. Select Add New App, set the environment to “Sandbox”, choose the Test API Product(s) you would like to access, then select Add App, to create your App. After the request is authorized, the consumer key and secret credentials will provide you with access to the Test API Product(s).
How do I obtain user credentials?
Users must be added to the system to work with Lumen APIs. Any user can register on the Lumen API Marketplace by selecting the Register link in the portal menu.
How do I create a User Account?
Open the Portal home page and fill out the Register form.
How do I register an application?
You can register multiple applications under the same user account using the MyApps page through the portal.
How do I obtain a Consumer Key and Secret?
When an application is added on the MyApps page, a Consumer Key and Secret will be assigned. After the application is approved for access to the API, the Consumer Key and Secret will be activated. Once activated, your application can call the Lumen Authorization Server to request an access token.
How do I sample an API?
Some of our API Products will provide the ability to try the function with mock data. You can find the “try it” capability in the API documentation. If you are ready to start developing and want to test the API, set up an application to get access to the API Product.
How do I access a Production API?
You first need to create a Production App on MyApps of the Marketplace. Select Add New App, set the environment to “Production”, choose the API Product(s) you would like to access, then select Add App to create your App. After the request is authorized, the consumer key and secret credentials will provide you with access to the Production API Product(s).
Support
Where can I find the latest release notes for the API Marketplace?
Select here for API Marketplace release notes.
What are the Supported Browsers for API Marketplace?
Chrome version 45 and higher (Mac and Windows) |
Firefox version 43 and higher (Mac and Windows) |
Edge version 15 and higher (Windows only)
How do I ask for help?
We’re here to help! Select Contact Us on any page in the API Marketplace, and you will be prompted to submit a form that will be delivered to our support team. The support team will contact you as soon as possible.
How do I sign up for Push Notifications?
Lumen offers customers the ability to sign up for push notifications to stay up-to-date about Scheduled Maintenances and Trouble Tickets through the API Marketplace portal.
How long are API versions supported?
We continually update our API inventory by adding new solutions or introducing new versions of existing APIs. Before we stop support of an API version, we will always communicate our plans well in advance.
Support
Where can I find the latest release notes for the API Marketplace?
Select here for API Marketplace release notes.
What are the Supported Browsers for API Marketplace?
Chrome version 45 and higher (Mac and Windows) |
Firefox version 43 and higher (Mac and Windows) |
Edge version 15 and higher (Windows only)
How do I ask for help?
We’re here to help! Select Contact Us on any page in the API Marketplace, and you will be prompted to submit a form that will be delivered to our support team. The support team will contact you as soon as possible.
How do I sign up for Push Notifications?
Lumen offers customers the ability to sign up for push notifications to stay up-to-date about Scheduled Maintenances and Trouble Tickets through the API Marketplace portal.
How long are API versions supported?
We continually update our API inventory by adding new solutions or introducing new versions of existing APIs. Before we stop support of an API version, we will always communicate our plans well in advance.
Security
How secure is the Lumen API Marketplace?
Lumen takes security seriously and uses multiple layers of security to keep your accounts and data secure. Lumen API Marketplace uses HTTPS. Lumen API Products use the OAuth 2.0 model for authentication and authorization.
What is OAuth 2.0?
The OAuth 2.0 authorization framework enables a third-party application to obtain limited access to an HTTP service, either on behalf of a resource owner by orchestrating an approval interaction between the resource owner and the HTTP service, or by allowing the third-party application to obtain access on its own behalf. This specification replaces the OAuth 1.0 protocol described in RFC 5849. For more information, visit our OAuth 2.0 page.
How is OAuth 2.0 used in the Lumen API Marketplace?
Lumen API Products use the OAuth 2.0 protocol for authorization. Lumen supports the OAuth 2.0 Client Credentials grant type flow for external access by applications. In summary, you will first obtain your OAuth 2.0 client credentials from the Lumen API Marketplace. Then your client application will request an access token from the Lumen Authorization Server, extract the access token from the response, and send the token as a Bearer token to the Lumen API endpoint that you want to access. For more information, visit our OAuth 2.0 page.
Security
How secure is the Lumen API Marketplace?
Lumen takes security seriously and uses multiple layers of security to keep your accounts and data secure. Lumen API Marketplace uses HTTPS. Lumen API Products use the OAuth 2.0 model for authentication and authorization.
What is OAuth 2.0?
The OAuth 2.0 authorization framework enables a third-party application to obtain limited access to an HTTP service, either on behalf of a resource owner by orchestrating an approval interaction between the resource owner and the HTTP service, or by allowing the third-party application to obtain access on its own behalf. This specification replaces the OAuth 1.0 protocol described in RFC 5849. For more information, visit our OAuth 2.0 page.
How is OAuth 2.0 used in the Lumen API Marketplace?
Lumen API Products use the OAuth 2.0 protocol for authorization. Lumen supports the OAuth 2.0 Client Credentials grant type flow for external access by applications. In summary, you will first obtain your OAuth 2.0 client credentials from the Lumen API Marketplace. Then your client application will request an access token from the Lumen Authorization Server, extract the access token from the response, and send the token as a Bearer token to the Lumen API endpoint that you want to access. For more information, visit our OAuth 2.0 page.
Lumen APIs
What APIs does the Lumen Marketplace offer?
Our API Products are available to view on the “API” tab on Lumen API Marketplace. We are always working on new API Products to deliver value to you. If you don’t see something you need, provide feedback on our API page. AG Changed this.
How does versioning work?
Lumen APIs use Semantic versioning to prevent breaking changes, and to make new functionality available. Major versions of API Products are noted in the API URL. Minor and Patch versions are noted in the release notes for each API Product.
Lumen APIs
What APIs does the Lumen Marketplace offer?
Our API Products are available to view on the “API” tab on Lumen API Marketplace. We are always working on new API Products to deliver value to you. If you don’t see something you need, provide feedback on our API page. AG Changed this.
How does versioning work?
Lumen APIs use Semantic versioning to prevent breaking changes, and to make new functionality available. Major versions of API Products are noted in the API URL. Minor and Patch versions are noted in the release notes for each API Product.
Overview
What is the Lumen API Marketplace?
The Lumen API Marketplace contains customer-driven network and data APIs that are simple, global, secure and reliable.
What is an API?
APIs, also known as Application Programming Interfaces, simplify communication between applications, allowing one application to consume capabilities or data from another. In other words, an API delivers a request for information from the provider, then delivers the response back.
Are Lumen APIs based on REST?
Lumen’s API Marketplace is based on REST, an acronym for Representational State Transfer.
Overview
What is the Lumen API Marketplace?
The Lumen API Marketplace contains customer-driven network and data APIs that are simple, global, secure and reliable.
What is an API?
APIs, also known as Application Programming Interfaces, simplify communication between applications, allowing one application to consume capabilities or data from another. In other words, an API delivers a request for information from the provider, then delivers the response back.
Are Lumen APIs based on REST?
Lumen’s API Marketplace is based on REST, an acronym for Representational State Transfer.
Getting Started
A Sandbox (also known as a Test) environment establishes credentials to a Sandbox environment for all API Products in your Sandbox App. A Production environment establishes credentials for all API Products in your Production App.
You first need to create a Sandbox App (also known as Test App) on MyApps of the Marketplace. Select Add New App, set the environment to “Sandbox”, choose the Test API Product(s) you would like to access, then select Add App, to create your App. After the request is authorized, the consumer key and secret credentials will provide you with access to the Test API Product(s).
Users must be added to the system to work with Lumen APIs. Any user can register on the Lumen API Marketplace by selecting the Register link in the portal menu.
Open the Portal home page and fill out the Register form.
You can register multiple applications under the same user account using the MyApps page through the portal.
When an application is added on the MyApps page, a Consumer Key and Secret will be assigned. After the application is approved for access to the API, the Consumer Key and Secret will be activated. Once activated, your application can call the Lumen Authorization Server to request an access token.
Some of our API Products will provide the ability to try the function with mock data. You can find the “try it” capability in the API documentation. If you are ready to start developing and want to test the API, set up an application to get access to the API Product.
You first need to create a Production App on MyApps of the Marketplace. Select Add New App, set the environment to “Production”, choose the API Product(s) you would like to access, then select Add App to create your App. After the request is authorized, the consumer key and secret credentials will provide you with access to the Production API Product(s).
A Sandbox (also known as a Test) environment establishes credentials to a Sandbox environment for all API Products in your Sandbox App. A Production environment establishes credentials for all API Products in your Production App.
You first need to create a Sandbox App (also known as Test App) on MyApps of the Marketplace. Select Add New App, set the environment to “Sandbox”, choose the Test API Product(s) you would like to access, then select Add App, to create your App. After the request is authorized, the consumer key and secret credentials will provide you with access to the Test API Product(s).
Users must be added to the system to work with Lumen APIs. Any user can register on the Lumen API Marketplace by selecting the Register link in the portal menu.
Open the Portal home page and fill out the Register form.
You can register multiple applications under the same user account using the MyApps page through the portal.
When an application is added on the MyApps page, a Consumer Key and Secret will be assigned. After the application is approved for access to the API, the Consumer Key and Secret will be activated. Once activated, your application can call the Lumen Authorization Server to request an access token.
Some of our API Products will provide the ability to try the function with mock data. You can find the “try it” capability in the API documentation. If you are ready to start developing and want to test the API, set up an application to get access to the API Product.
You first need to create a Production App on MyApps of the Marketplace. Select Add New App, set the environment to “Production”, choose the API Product(s) you would like to access, then select Add App to create your App. After the request is authorized, the consumer key and secret credentials will provide you with access to the Production API Product(s).
Support
Select here for API Marketplace release notes.
Chrome version 45 and higher (Mac and Windows) | Firefox version 43 and higher (Mac and Windows) | Edge version 15 and higher (Windows only)
We’re here to help! Select Contact Us on any page in the API Marketplace, and you will be prompted to submit a form that will be delivered to our support team. The support team will contact you as soon as possible.
Lumen offers customers the ability to sign up for push notifications to stay up-to-date about Scheduled Maintenances and Trouble Tickets through the API Marketplace portal.
We continually update our API inventory by adding new solutions or introducing new versions of existing APIs. Before we stop support of an API version, we will always communicate our plans well in advance.
Select here for API Marketplace release notes.
Chrome version 45 and higher (Mac and Windows) | Firefox version 43 and higher (Mac and Windows) | Edge version 15 and higher (Windows only)
We’re here to help! Select Contact Us on any page in the API Marketplace, and you will be prompted to submit a form that will be delivered to our support team. The support team will contact you as soon as possible.
Lumen offers customers the ability to sign up for push notifications to stay up-to-date about Scheduled Maintenances and Trouble Tickets through the API Marketplace portal.
We continually update our API inventory by adding new solutions or introducing new versions of existing APIs. Before we stop support of an API version, we will always communicate our plans well in advance.
Security
Lumen takes security seriously and uses multiple layers of security to keep your accounts and data secure. Lumen API Marketplace uses HTTPS. Lumen API Products use the OAuth 2.0 model for authentication and authorization.
The OAuth 2.0 authorization framework enables a third-party application to obtain limited access to an HTTP service, either on behalf of a resource owner by orchestrating an approval interaction between the resource owner and the HTTP service, or by allowing the third-party application to obtain access on its own behalf. This specification replaces the OAuth 1.0 protocol described in RFC 5849. For more information, visit our OAuth 2.0 page.
Lumen API Products use the OAuth 2.0 protocol for authorization. Lumen supports the OAuth 2.0 Client Credentials grant type flow for external access by applications. In summary, you will first obtain your OAuth 2.0 client credentials from the Lumen API Marketplace. Then your client application will request an access token from the Lumen Authorization Server, extract the access token from the response, and send the token as a Bearer token to the Lumen API endpoint that you want to access. For more information, visit our OAuth 2.0 page.
Lumen takes security seriously and uses multiple layers of security to keep your accounts and data secure. Lumen API Marketplace uses HTTPS. Lumen API Products use the OAuth 2.0 model for authentication and authorization.
The OAuth 2.0 authorization framework enables a third-party application to obtain limited access to an HTTP service, either on behalf of a resource owner by orchestrating an approval interaction between the resource owner and the HTTP service, or by allowing the third-party application to obtain access on its own behalf. This specification replaces the OAuth 1.0 protocol described in RFC 5849. For more information, visit our OAuth 2.0 page.
Lumen API Products use the OAuth 2.0 protocol for authorization. Lumen supports the OAuth 2.0 Client Credentials grant type flow for external access by applications. In summary, you will first obtain your OAuth 2.0 client credentials from the Lumen API Marketplace. Then your client application will request an access token from the Lumen Authorization Server, extract the access token from the response, and send the token as a Bearer token to the Lumen API endpoint that you want to access. For more information, visit our OAuth 2.0 page.
Lumen APIs
Our API Products are available to view on the “API” tab on Lumen API Marketplace. We are always working on new API Products to deliver value to you. If you don’t see something you need, provide feedback on our API page. AG Changed this.
Lumen APIs use Semantic versioning to prevent breaking changes, and to make new functionality available. Major versions of API Products are noted in the API URL. Minor and Patch versions are noted in the release notes for each API Product.
Our API Products are available to view on the “API” tab on Lumen API Marketplace. We are always working on new API Products to deliver value to you. If you don’t see something you need, provide feedback on our API page. AG Changed this.
Lumen APIs use Semantic versioning to prevent breaking changes, and to make new functionality available. Major versions of API Products are noted in the API URL. Minor and Patch versions are noted in the release notes for each API Product.
Overview
The Lumen API Marketplace contains customer-driven network and data APIs that are simple, global, secure and reliable.
APIs, also known as Application Programming Interfaces, simplify communication between applications, allowing one application to consume capabilities or data from another. In other words, an API delivers a request for information from the provider, then delivers the response back.
Lumen’s API Marketplace is based on REST, an acronym for Representational State Transfer.
The Lumen API Marketplace contains customer-driven network and data APIs that are simple, global, secure and reliable.
APIs, also known as Application Programming Interfaces, simplify communication between applications, allowing one application to consume capabilities or data from another. In other words, an API delivers a request for information from the provider, then delivers the response back.
Lumen’s API Marketplace is based on REST, an acronym for Representational State Transfer.
Getting Started
A Sandbox (also known as a Test) environment establishes credentials to a Sandbox environment for all API Products in your Sandbox App. A Production environment establishes credentials for all API Products in your Production App.
You first need to create a Sandbox App (also known as Test App) on MyApps of the Marketplace. Select Add New App, set the environment to “Sandbox”, choose the Test API Product(s) you would like to access, then select Add App, to create your App. After the request is authorized, the consumer key and secret credentials will provide you with access to the Test API Product(s).
Users must be added to the system to work with Lumen APIs. Any user can register on the Lumen API Marketplace by selecting the Register link in the portal menu.
Open the Portal home page and fill out the Register form.
You can register multiple applications under the same user account using the MyApps page through the portal.
When an application is added on the MyApps page, a Consumer Key and Secret will be assigned. After the application is approved for access to the API, the Consumer Key and Secret will be activated. Once activated, your application can call the Lumen Authorization Server to request an access token.
Some of our API Products will provide the ability to try the function with mock data. You can find the “try it” capability in the API documentation. If you are ready to start developing and want to test the API, set up an application to get access to the API Product.
You first need to create a Production App on MyApps of the Marketplace. Select Add New App, set the environment to “Production”, choose the API Product(s) you would like to access, then select Add App to create your App. After the request is authorized, the consumer key and secret credentials will provide you with access to the Production API Product(s).
A Sandbox (also known as a Test) environment establishes credentials to a Sandbox environment for all API Products in your Sandbox App. A Production environment establishes credentials for all API Products in your Production App.
You first need to create a Sandbox App (also known as Test App) on MyApps of the Marketplace. Select Add New App, set the environment to “Sandbox”, choose the Test API Product(s) you would like to access, then select Add App, to create your App. After the request is authorized, the consumer key and secret credentials will provide you with access to the Test API Product(s).
Users must be added to the system to work with Lumen APIs. Any user can register on the Lumen API Marketplace by selecting the Register link in the portal menu.
Open the Portal home page and fill out the Register form.
You can register multiple applications under the same user account using the MyApps page through the portal.
When an application is added on the MyApps page, a Consumer Key and Secret will be assigned. After the application is approved for access to the API, the Consumer Key and Secret will be activated. Once activated, your application can call the Lumen Authorization Server to request an access token.
Some of our API Products will provide the ability to try the function with mock data. You can find the “try it” capability in the API documentation. If you are ready to start developing and want to test the API, set up an application to get access to the API Product.
You first need to create a Production App on MyApps of the Marketplace. Select Add New App, set the environment to “Production”, choose the API Product(s) you would like to access, then select Add App to create your App. After the request is authorized, the consumer key and secret credentials will provide you with access to the Production API Product(s).
Support
Select here for API Marketplace release notes.
Chrome version 45 and higher (Mac and Windows) | Firefox version 43 and higher (Mac and Windows) | Edge version 15 and higher (Windows only)
We’re here to help! Select Contact Us on any page in the API Marketplace, and you will be prompted to submit a form that will be delivered to our support team. The support team will contact you as soon as possible.
Lumen offers customers the ability to sign up for push notifications to stay up-to-date about Scheduled Maintenances and Trouble Tickets through the API Marketplace portal.
We continually update our API inventory by adding new solutions or introducing new versions of existing APIs. Before we stop support of an API version, we will always communicate our plans well in advance.
Select here for API Marketplace release notes.
Chrome version 45 and higher (Mac and Windows) | Firefox version 43 and higher (Mac and Windows) | Edge version 15 and higher (Windows only)
We’re here to help! Select Contact Us on any page in the API Marketplace, and you will be prompted to submit a form that will be delivered to our support team. The support team will contact you as soon as possible.
Lumen offers customers the ability to sign up for push notifications to stay up-to-date about Scheduled Maintenances and Trouble Tickets through the API Marketplace portal.
We continually update our API inventory by adding new solutions or introducing new versions of existing APIs. Before we stop support of an API version, we will always communicate our plans well in advance.
Security
Lumen takes security seriously and uses multiple layers of security to keep your accounts and data secure. Lumen API Marketplace uses HTTPS. Lumen API Products use the OAuth 2.0 model for authentication and authorization.
The OAuth 2.0 authorization framework enables a third-party application to obtain limited access to an HTTP service, either on behalf of a resource owner by orchestrating an approval interaction between the resource owner and the HTTP service, or by allowing the third-party application to obtain access on its own behalf. This specification replaces the OAuth 1.0 protocol described in RFC 5849. For more information, visit our OAuth 2.0 page.
Lumen API Products use the OAuth 2.0 protocol for authorization. Lumen supports the OAuth 2.0 Client Credentials grant type flow for external access by applications. In summary, you will first obtain your OAuth 2.0 client credentials from the Lumen API Marketplace. Then your client application will request an access token from the Lumen Authorization Server, extract the access token from the response, and send the token as a Bearer token to the Lumen API endpoint that you want to access. For more information, visit our OAuth 2.0 page.
Lumen takes security seriously and uses multiple layers of security to keep your accounts and data secure. Lumen API Marketplace uses HTTPS. Lumen API Products use the OAuth 2.0 model for authentication and authorization.
The OAuth 2.0 authorization framework enables a third-party application to obtain limited access to an HTTP service, either on behalf of a resource owner by orchestrating an approval interaction between the resource owner and the HTTP service, or by allowing the third-party application to obtain access on its own behalf. This specification replaces the OAuth 1.0 protocol described in RFC 5849. For more information, visit our OAuth 2.0 page.
Lumen API Products use the OAuth 2.0 protocol for authorization. Lumen supports the OAuth 2.0 Client Credentials grant type flow for external access by applications. In summary, you will first obtain your OAuth 2.0 client credentials from the Lumen API Marketplace. Then your client application will request an access token from the Lumen Authorization Server, extract the access token from the response, and send the token as a Bearer token to the Lumen API endpoint that you want to access. For more information, visit our OAuth 2.0 page.
Lumen APIs
Our API Products are available to view on the “API” tab on Lumen API Marketplace. We are always working on new API Products to deliver value to you. If you don’t see something you need, provide feedback on our API page. AG Changed this.
Lumen APIs use Semantic versioning to prevent breaking changes, and to make new functionality available. Major versions of API Products are noted in the API URL. Minor and Patch versions are noted in the release notes for each API Product.
Our API Products are available to view on the “API” tab on Lumen API Marketplace. We are always working on new API Products to deliver value to you. If you don’t see something you need, provide feedback on our API page. AG Changed this.
Lumen APIs use Semantic versioning to prevent breaking changes, and to make new functionality available. Major versions of API Products are noted in the API URL. Minor and Patch versions are noted in the release notes for each API Product.
Overview
The Lumen API Marketplace contains customer-driven network and data APIs that are simple, global, secure and reliable.
APIs, also known as Application Programming Interfaces, simplify communication between applications, allowing one application to consume capabilities or data from another. In other words, an API delivers a request for information from the provider, then delivers the response back.
Lumen’s API Marketplace is based on REST, an acronym for Representational State Transfer.
The Lumen API Marketplace contains customer-driven network and data APIs that are simple, global, secure and reliable.
APIs, also known as Application Programming Interfaces, simplify communication between applications, allowing one application to consume capabilities or data from another. In other words, an API delivers a request for information from the provider, then delivers the response back.
Lumen’s API Marketplace is based on REST, an acronym for Representational State Transfer.