Authorization API
OAuth 2.0 is the protocol that allows your application or your application users to access RICOH Cloud API services. Every use of RICOH Cloud API services requires authorization for the service. This page shows the difference among supported authorization types and their common usage.
Contents
Authorization Type
RICOH Cloud API supports OAuth 2.0 authorization flows.
- Client Credentials Grant - Authorizes your application to use a RICOH Cloud API resource.
- Authorization Code Grant - Authorizes your application and your application users to use a RICOH Cloud API resource.
You need to use the flow required by the service you wish to use. Check out the following table to understand which flow you need to choose:
| RICOH Cloud API Service | Grant Type |
|---|---|
| Visual Recognition API | Client Credentials Grant |
| Image Processing API | Client Credentials Grant |
| Live Streaming API | Client Credentials Grant |
| Peer-to-Peer Communication API | Authorization Code Grant |
| Messaging API | Authorization Code Grant |
Service Code
During authorization process, you need a service code. You can learn how to use one in Client Credentials Grant or Authorization Code Grant. All RICOH Cloud API services have their own service codes:
| RICOH Cloud API Service | Service Code |
|---|---|
| Visual Recognition API > Human Detection | ips.api.ricoh/v1/detect_humans |
| Visual Recognition API > Face Detection | ips.api.ricoh/v1/detect_faces |
| Visual Recognition API > Face Recognition | ips.api.ricoh/v1/compare_faces |
| Image Processing API > Image Filtering | vps.api.ricoh/v1/filter |
| Live Streaming API | sfu.api.ricoh/v1/sfu |
| Peer-to-Peer Communication API | turn.api.rioch/v1/turn |
| Messaging API | xmpp.api.ricoh/v1/http-bind |
The format of service codes is <domain name>/<version>/<service name>.