Quick Start Guide
Getting started
If you are new to UBIAI Open Platform, this guide would help you step by step how to onboard the platform, start the development of your application with UBIAI Open Platform API
- Become a developer - Register an account and sign up as a UBIAI Open Platform developer.
- Retrieve Client ID and Client Secret of your application - The unique identity of your application on the UBIAI Open Platform.
- OAuth2.0 in one of the application categories - Submit the request and UBIAI Open Platform admins will review and approve your request.
- Request API permission for your application, so that your application can initiate calls to UBIAI Open Platform APIs.
- Start development of your application - Learn how to interact with UBIAI Open Platform API. You could find more technical details from the Developer’s Guide section.
Become a developer
Take the following steps to register a developer account on UBIAI Open Platform:
- Open the UBIAI Open Platform home page at https://open.youbiai.com/api/guides/getting-started/index, and click Sign Up;
- On the page that is open, enter your email and password, read the UBIAI Open Platform Developer Agreement, and accept it as appropriate, and then click the next button;
- On the page that is open, enter your nickname、optional profile, click complete;
- Open the activation email in your mailbox, click the activation link to open the account activation page. Note that the activation email might be in the junk mailbox;
- Your developer account has been created successfully, and you can log in UBIAI Open Platform to start your application development. Retrieve Client ID and Client Secret.
Client ID is the unique identity of an application on UBIAI Open Platform. Client Secret is the key that is assigned to an application by UBIAI Open Platform, which ensures the security and reliability of the application source. You must keep the Client Secret properly and should not share it with any third party.
An Access Token is one of the parameters that must be included in the request of API calls, and the application will be identified with the Access Token by UBIAI Open Platform. You can get it by calling token API and carring the client_id and client_secret parameters.
OAuth2.0 Protocol
OAuth 2.0 is the industry-standard protocol for authorization. OAuth 2.0 supersedes the work done on the original OAuth protocol created in 2006. OAuth 2.0 focuses on client developer simplicity while providing specific authorization flows for web applications, desktop applications, mobile phones, and living room devices. This specification and its extensions are being developed within the IETF OAuth Working Group.
Either it represents users through authorized interactions between resource owners and HTTP service providers, or it allows third-party applications to gain access on behalf of users. At the same time, it provides a special authentication process for Web applications, desktop applications and mobile phones.
Before Calling UBIAI Open Platform APIs, the following two steps need to by completed.
Get Access Token
Request URI：https://open.youbiai.com/connect/oauth2/access-token
Request Method：POST
Request Content-Type：application/x-www-form-urlencoded
Request Parameters：
| name | type | value | optional | description |
|---|---|---|---|---|
| grant_type | string | client_credentials | true | Response type (fixed value) |
| client_id | string | true | Client id | |
| client_secret | string | true | Client key |
Response Parameters：
| name | type | value | description |
|---|---|---|---|
| access_token | string | Token value returned | |
| token_type | string | Bearer | The type of the token |
| expires_in | int | Token timeout in seconds | |
| refresh_token | string | Access_token refresh code | |
| scope | string | List of permission strings, separated by commas |
Request API permission
UBIAI Platform developers are divided into two types: individual users and enterprise users. Individual users can be the early stage of product research and development, students, research institutes and other learning institutions. Enterprise developer customer is an enterprise subject with operation qualification, high service invocation requirement and technical development staff.
Start development
After Retrieving Client ID and Client Secret on UBIAI Open Platform, you can start developing your application.
You may need the following information during the application development:
- Get Access_Token - Instructions on assembling HTTP requests to get the access_token parameter for API calls.
- Call API with HTTP requests - Instructions on assembling HTTP requests to call the API.
- API reference - Complete reference documentation for each API.