Verizon Partner Solutions API developer portal is a digital transformation initiative to let our partner solutions system access the Verizon APIs in a simple, quick and easy manner. This portal is the home for all things API at Verizon Partner Solutions. Ready to start interfacing with Verizon APIs? We have made is simpler for you to start using our APIs in as easy as 5 simple steps.
Discover available APIs in the Solutions page.
Download PDF documentation; use the Swagger User Interface tool to learn about an API; invoke a sample test; download sample code to get started.
As an API developer, learn how to test and consume APIs faster using self-serve features.
Register to get login credentials for company ‘Administrator’ and ‘Developer’ accounts.
Developer account is for users who develop and test applications using APIs.
Company Admin account is for Supervisors / IT Leads managing API subscriptions and responsible for API Access keys to production.
All Developer and Company Admin registration is approved by VZ Connectivity Team.
Please click here for details with regards to user registration..
Access to an API is managed through subscription.
API key is provided upon successful subscription request and approval by VZ Connectivity Team.
Calling APIs in the Production Environment: Production API credentials can be requested by Administrator account only.
Please click here for details with regards to subscription..
Step 4 → Consume APIs
Use the API keys provided during subscription to consume FTTI (Fiber to the Internet) API.
These API Keys are used to authenticate API calls.
More information on the use of authentication implementation and use is available here. OAuth 2.0
Each API under the Solutions page has associated Request/Response specification PDF.
APIs enabled with 2-way ssl, client applications needs a valid certificate.
Please register with VPS partner solutions API program and share your public certificate details to Connectivity Management Team.
More information on the use of authentication implementation and use is available here. 2-WaySSL
Each API under the Solutions page has associated Request/Response specification PDF.
Step 5 → Manage APIs
Manage API subscription using ‘API Subscription Dashboard’ page.
This Dashboard is available after you login to the portal as a registered user.
All API Keys can be found under ‘API Subscription Dashboard’.
‘API Subscription Dashboard’ provides information about all subscribed APIs with associated Keys and Statistics.
OAUTH_URL
https://partnersolutionsconnectproxy.verizon.com:443/oauth/
client_credential/accesstoken?grant_type=client_credentials
OAuth 2.0 is the industry-standard protocol for authentication and authorization. All Verizon APIs are protected by OAuth 2.0.
1) Obtain the client credentials by subscribing to the API
Client applications need Client ID and Client Secret to obtain the oAuth 2.0 access token. To obtain the client credentials , go to the 'Develop' tab click on the "Subscribe Now" button to subscribe to an API.Once the subsription has been approved,click on the subscription name to obtain the client key and secret.Separate client credentials are provided for test and production environment.
For the production environment,the Client ID and Secret are provided only to the Company Admin.
2) Obtain the accessToken.
Before the client application can access Verizon APIs , it must obtain an access token that grants access to that API.To obtain the access token, call the acess token POST URL 'OAUTH_URL' by sending the Client ID & Secret in the HTTP basic authentication header. The body of this request should be set to 'grant_type=client_credentials'.
3) Invoke the API.
Once the access token is obtained, invoke the API call with the accesstoken set in the HTTP authorization header.
4) Refresh the accesstoken.
Access tokens have limited lifetimes. The access token Verizon issues are valid for 60 minutes. If the client applications needs invoke the API beyond the lifetime of a single access token, a new access token is to be obtained. Invoke the access token URL every 55 mins to get a new token.
OAuth Access Workflow
2-WaySSL
Once the contract is signed, Please subscribe to the available API’s. All the APIs in the verizon follows 2-Way SSL. To consume the APIs please send a valid Certificate to the Connectivity Management team Via email (connectivity.management.team@one.verizon.com).
How 2-WaySSL works?
The client should get and provide certificate to verizon on their own. These certificates are then stored in the Edge TLS Keystores. On every request client will be establishing the connection using the certificate shared above. Then the request goes to the TLS server and validates.(Eg: it checks for company name, user, validity,..) The API response is displayed.
Users can register for an account using the Register link in the home page as highlighted below.
Clicking on the Register Link will pop-up a window with the registration fields. Please enter the required information and select the desired user type and submit your user registration. All registrations will be reviewd by the Verizon Connectivity Management Team
Your subscription dashbord can be accessed using the My Apps link in the home page as highlighted below.
The subscription dashboard shows the existing subscriptions and the link to adding a new subscription.
Clicking on any of the existing subscription will expand the row to display the subscription details (API products in the subscription, Keys, link to edit / delete subscription).
Clicking on the New Subscription will navigate the user to the new subscriptions page where users can create a new subscription to additional APIs. As detailed in the Getting Started page, Admin users can subscribe to API products in test as well as production environment. Developers will only see test environment for subscription.