docomo Developer support Common Guidelines for Using APIs€¦ · DOCOMO will check the apps using the APIs and contents of their services using the APIs as necessary. In case they

Copyright © 2017 NTT DOCOMO, Inc. All Rights Reserved

1

docomo Developer support

Common Guidelines for Using APIs

Version 2.0.9

April 11, 2018

NTT DOCOMO, Inc.

Revision History


2

Date Version Contents of revision

Nov. 11, 2013 1.0.0 1st version

Mar. 17, 2014 2.0.0

・Revision of the flow diagram in 2.2.

・Revision of the content in 2.5.1

・Removal of Chapter 3.4

・Addition of the following sections

2.3.2. APIs requiring identity verification

3. Identity documents

May. 23, 2014 2.0.1 ・Revision of the content in 2.5.1

May. 29, 2014 2.0.2 ・Revision of the content in 2.3.1

September. 16,

2014

2.0.3 ・Revision of the content in 2.5.1

October. 23,

2014

2.0.4 ・Revision of table in 2.3.1

November. 28,

2014

2.0.5 ・Revision of the content in 2.3

November.

10,2015


October.

13,2017



April

11,2018




3

Table of contents

1. Introduction ............................................................................................................................ 4

2. Procedures for using the APIs ............................................................................................... 5

2.1. Before using the APIs ...................................................................................................... 5

2.2. Outline .............................................................................................................................. 5

2.3. Phase for development use ............................................................................................... 7

2.3.1. Information needed for applying for use

of APIs .................................................................................................................................. 7

2.3.2. APIs requiring identity verification ......................................................................... 8

2.3.3. Information to be disclosed to users ........................................................................ 8

2.4. Addition of API functions to API keys for

development ............................................................................................................................ 9

2.5. Phase for commercial distribution use ...................................................................... 10

2.5.1. Documents required for “Apply for

Commercial Usage” .......................................................................................................... 10

3. Identity documents ............................................................................................................... 12

3.1. Acceptable identify documents ..................................................................................... 12

4. Basic regulations for using APIs .......................................................................................... 14

4.1. Indication of usage of APIs .......................................................................................... 14

4.2. Cancellation of usage of APIs ..................................................................................... 14

4.3. Inquiry/Contact Us support ....................................................................................... 15

5. Others (Regarding docomo Developer support) .............................................................. 19

5.1. For those who use the APIs for the first time .............................................................. 19

5.2. Provide the APIs ............................................................................................................. 19

5.3. Development information .............................................................................................. 19

5.4. Technology blog .............................................................................................................. 19

5.5. Application procedures and management of

APL/API ................................................................................................................................ 19

5.6. Check and change account information ...................................................................... 19

5.7. Delete accounts ............................................................................................................... 19

5.8. API Console .................................................................................................................... 20

5.9. Contact Us /Inquires ...................................................................................................... 20


4

1. Introduction

For the use of APIs of docomo Developer support, this guideline is applied as well as the ‘Terms of Use’

defined by DOCOMO separately. The scope to which this guideline (especially the clauses on

regulations) applies includes external connections such as where services using the APIs (hereafter called

a “service using the API”) are linked to and display of advertisement.

Further, there are cases where individual guidelines (hereafter called “individual guidelines”) are defined

for the APIs. For such APIs, both this guideline and the individual guidelines are applied. Please note that

in case there are discrepancies etc., the individual guidelines are applied with priority.

DOCOMO will check the apps using the APIs and contents of their services using the APIs as necessary.

In case they are found to be not conforming to this guideline and the individual guidelines, DOCOMO

may cancel the usage of the APIs. So please read the guidelines carefully before using the APIs.

DOCOMO may change the contents of this guideline. Please reference the latest guideline for using

docomo Developer support.


5

2. Procedures for using the APIs

2.1. Before using the APIs

Before using the APIs, a developer must register an account for docomo Developer support.

After obtaining an account, please go through the procedure to use APIs from My Page.

2.2. Outline

For development and commercial apps distribution, “API keys” are required for executing the APIs from

the apps. Please have the API keys issued by applying for the usage of APIs following the flow below.

Please note that the application for usage is required per app. First, apply for the apps, then select API

functions to be used and apply for the usage.

Further, the API keys have “Phase for development use” and “Phase for commercial distribution use”,

and the developer must apply for their usage separately.


6

First, when usage of an API is applied for in the “Phase for development use”, an API key (API key for

development) is issued with restrictions such as expiration date. Please use this API key for development

to develop apps. In the “Phase for commercial distribution use” after completing the development, please

apply for approval to distribute you apps from My Page of docomo Developer support. When the

application passes the reviewing, restrictions of the API key are removed and it becomes available for the

operation of a service using the API.


7

2.3. Phase for development use

In the “Phase for development use”, for using an API, the developer must register information of an app to be

developed and apply for the API to be used. Please log on to My Page and apply for the use of API from

“Newly apply for the use of API”. After applying for the usage, an API key (*) for development is issued.

From here on, the developer can develop the app by using the API key. Please check this guideline and

individual guidelines for using the API.

*With regard to dphoto API, Data Storage BOX API, API keys for development have the following

restrictions:

・ Effective period: 90 days

When the effective period has passed, the API keys become invalid.

Please be aware that, in principle, the effective period cannot be extended.

2.3.1. Information needed for applying for use of APIs

In order for DOCOMO to review an application for using the APIs, the developer must register the following

information on the site of docomo Developer support.

NO Item M/O Outline

1 App name Mandatory Name of the app to be developed

2 Outline of app Mandatory Contents of the app to be developed (Describe the

outline of contents to be provided)

3 Scheduled start date of the

service using the API

Mandatory Scheduled start date of the service using the API

of the app to be developed

4 Icon image of the service

using the API

Optional Icon of the app to be developed

5 App type Mandatory Select either “web app” or “native app”. Note that

web apps are those run on the web server, and

native apps are those run by being installed in

Android terminals etc.

6 Call back URL Mandatory Call back URL in case the API requiring user

authentication performs authentication Specify

https as the protocol.

7 Provider Mandatory Name of the developer regarding the app to be

developed

8 Support mail address Mandatory Contacting mail address regarding the app to be

developed

9 Site URL Optional Site URL provided by the service using the API.


8

In case the app type is web app, this is mandatory

at “Application for approval to distribute your

apps”.

10 Name *Mandatory Name of yourself

11 Residence Location *Mandatory Country of residence

12 Phone Number *Mandatory Phone number of yourself

*In case of you apply for the use of API which is required DOCOMO’s reviewing when you apply for

Commercial Usage.

2.3.2. APIs requiring identity verification

For certain APIs, DOCOMO will perform identity verification of a developer in order to decide whether

the developer is qualified to use the APIs. When choosing any of such APIs in applying for the use of

APIs, the developer is asked to submit a document to verify the developer’s identity on the screen for

API usage application to enable DOCOMO to perform identity verification (partner review). As to which

identity documents are acceptable, please refer to “3. Identity documents” in this guideline document.

A developer who has passed the verification process conducted by DOCOMO will receive an email to

that effect. Simultaneously, a document containing a “partner key” will be sent to the address specified in

advance (the document will be mailed to the name and address of the developer shown in the Developer

Information). Upon receiving the document, please enter the partner key on the “API usage application

screen” of docomo Developer support. By entering the key, the developer will be authorized to be a

partner, who is eligible to use the APIs that only the partners are qualified to access.

A developer who has not passed the verification process will also receive an email to that effect. The

developer who has received such an email is requested to revise its Developer Information on the “API

usage application screen” of docomo Developer support. A reason why the application of the developer

was turned down will be shown on the detailed screen of the “API usage application” screen.

2.3.3. Information to be disclosed to users

Please take notice that the following items are disclosed to general customers on the screens displayed by

DOCOMO.

① Name of the service using the API

② Provider

③ Support mail address

④ Site URL

⑤ Icon image


9

Fig. Image of screen displayed to general customers

2.4. Addition of API functions to API keys for development

It is possible to add API functions to the API keys for development. When functions need to be added,

please “Add APIs for App” from the corresponding app page on the docomo Developer support site.

Please note that even when API functions are added, the effective period of the API keys for development

is not extended.


10

2.5. Phase for commercial distribution use

When app development using the API key for development is completed, please perform “Apply for

Commercial Usage” from the corresponding app page on the docomo Developer support site. In case an

API which requires DOCOMO’s reviewing is used, the following documents for reviewing must be

submitted at “Apply for Commercial Usage”. At the reviewing, DOCOMO checks the contents of the

service using the API based on “3. Basic regulations for using APIs” in this guideline. When the

application passes the reviewing, restrictions of the API key for development are removed and the

corresponding API becomes available for the service using the API. In case APIs which do not require

DOCOMO’s reviewing are used, by completing the “Apply for Commercial Usage”, the corresponding

APIs become available for the services using the APIs.

2.5.1. Documents required for “Apply for Commercial Usage”

In order for DOCOMO to review the Application for approval to distribute your apps commercially ,

documents for reviewing must be submitted on the docomo Developer support site by conforming to the

following procedures.

Documents for reviewing: Proposal description document for the application

and app itself

*Please submit all the documents for reviewing in one ZIP file

*Please set a password for the ZIP file and upload it on the docomo Developer

support site

*The maximum size allowed for submission is 20 Mbytes

*Request for reviewing: Please indicate necessary information such as matters

to be passed onto

Details of the documents for reviewing are as follows:

[Proposal description document for the app]

Please indicate the following.

A)Outline of the Application ( To explain what kind of Application you wish to develop and how it shall

be used )

B) Environments and operational procedures required for executing the app (Hardware, URL, how to

install, how to setup, how to become a member/withdraw/login, etc.), from where the API is called

(image of screen from which requests and responses are made etc.), etc.

C) Conditions for providing the app

(i) Types of users to whom the app is provided (Private user or corporation etc.)

(ii) Conditions for provisioning (Free-of-charge or charged etc.)

(iii) Areas of provisioning (In Japan or overseas etc.)


11

(iv) App Market Place (e.g Google Play/ App Store ) and Application Name The proposal description

document can be written in any format.

D) List of docomo’s SDK you have used for developing the App (e.g Character Recognition API)

You are free to submit the document containing the above contents in any format of your choice.

We have tabulated the important points that we check as you submit your App for review. Please make

sure to prepare the Proposal description document for the app after going through the following points to

be aware of how your App will be reviewed.

API Important Points How the check is done

All APIs Check if the necessary morals specified in the chapter

4.4 in this document are satisfied.

Checking on the App

summary and the App

screen transition / App

screen capture images.

Character

Recognition API

Voice

Composition API

(Powered by NTT

TX)

Speech

Recognition

API(Powered by

NTT TX)

Check if the conditions specified for this

corresponding API are satisfied

Check on the Conditions for

providing the app and the

intended end –users etc.

Trend Article

Extraction API

Check if the proper recognition is explicitly

mentioned to satisfy the copyright restriction when

the third party information is used.

Checking on the App

summary and the App



dphoto API

Data Storage Box

API

The App screen is checked for the following ・Is

there a proper description provided in the App about

the purpose of usage of the corresponding API . ・Is

there a provision for a link within the App to cancel

/remove the usage of corresponding API. ・Is there

a provision for the end user to contact the content

provider directly.

Checking on the App

summary and the App




12

3. Identity documents

3.1. Acceptable identify documents

In order to be qualified to use certain APIs provided by DOCOMO, the developer must submit an identify

document/documents shown in the list below.

Service

provider Documents to be submitted

Individual One of the following documents from ① to ⑥

① Japanese driver’s license

(must show the both sides of the license

card when the current address of the

developer is written on the back side)

Must be issued by a prefectural or

metropolitan Public Safety Commission

(International driver's licenses will not be

accepted.)

② Japanese passport

③Basic Resident Registration Card Must show a photo of the face

④Certificate of Alien Registration or

residence card

Must have a valid status of residence and

permission of stay at least for 90 days

until the expiry date

⑤Government-issued identification

booklet for the physically challenged),

government-issued identification booklet

for the mentally challenged, or

government-issued welfare booklet for

the mental ill

Must attach a “photo of the face” on the

“space for a photo of the face” whenever

such space is prepared


13

⑥Japanese Health Insurance Certificate

＋ one of the following

・A receipt of public utility charges

・A credit card

・A student identification card

・A certificate of residence

・A certification of information

recorded on foreign resident registration

file *Must be unexpired if any expiry

date is set

Must be a utility receipt, certificate of

residence, or certification of information

recorded on foreign resident registration

file that was issued within the last three

months and show the current address on

it. (Only utility receipts for electricity,

city gas, water, NTT East/NTT West

bearing a receipt stamp or automatic

payment notices showing the date of

automatic payment are accepted.)

A student identification card must show

the “name”, the “date of birth,” a “photo

of the face,” or the “current address.”

Company A Certified (extract) Copy of Commercial

Registration

( Certificate of Present (Historical) Matters)

+ A business card of the person who applies

A Certified (extract) Copy of Commercial

Registration ( Certificate of Present

(Historical) Matters) must have been

issued within the last three months and

show the current address.

*Must include the “business name,” the

“main office,” “how to place a public

notice, ”the “date of establishment of the

company,” “matters concerning officials”

(extraction of only the relevant pages is

acceptable).

・Please note that the application will be turned down by DOCOMO if the name or the address of the

developer cannot be confirmed on the identity document(s) by DOCOMO.


14

4. Basic regulations for using APIs

At the reviewing of “Application for approval to distribute your apps”, DOCOMO checks whether the

contents of applications conform to this guideline, the individual guidelines and Terms of Use. Please note

that in case the contents of applications are found to be not conforming to this guideline, the individual

guidelines and Terms of Use, DOCOMO may cancel the usage of the APIs.

4.1. Indication of usage of APIs

For starting to use an API requiring authentication authorization for an end user, please indicate the usage

such as what can be done by using DOCOMO clouds and how they are presented to the end user, then

transit to the authentication authorization screen for API. Further, in case authentication authorization is

to be granted, it must be done for the end user on the corresponding service. Use of APIs by using access

tokens obtained through authentication authorization for other services is prohibited.

4.2. Cancellation of usage of APIs

For cancelling the use of an API requiring authentication authorization for an end user, please setup a link

to the “Cloud service collaboration cancellation screen” (URL below). Further, the link must be directly

Please include the link to direct the end users to set the cloud service usage ( ON )


15

lead to the “Cloud service collaboration cancellation screen” without inserting a page such as “Do you

really want to cancel?”.

https://api.smt.docomo.ne.jp/cgi9/auth/list

4.3. Inquiry/Contact Us support

Inquires from end users on services using the APIs must be supported by the providers of the services

using the APIs. Please clearly indicate “Contact point for inquires” (A mail address or phone number that

can be reached without fail) in an easy to find location within the services using the APIs or prepare a

link to the page in which the same information can be checked. (In case a link is prepared, the indication

should be

“Inquires” or the like).

4.4. Regulations concerning public policy

In case a service using the API corresponds to one of the following, DOCOMO may refuse the service to

use the docomo Developer support service.

4.4.1. In case a service using the API betrays trust of DOCOMO’s users

A service using the API must be sensible and must not betray trust of DOCOMO’s users (hereafter called

“DOCOMO users”).

Please include the link to direct the end users to set the cloud service usage ( OFF)




16

<Examples of services using the APIs that must not be provided>

① Provider or purpose of a service using the API is unknown.

② In case a service using the API is provided with a charge, either the amount of consideration

presented to the customers is ambiguous or is involving malicious acts such as illegal charging.

③ Expressions regarding a service using the API are either false or inaccurate (E.g. Groundless

speculation of gambling or investment).

④ A service using the API violates public policy (E.g. Sexual expressions, violent expressions,

encourage crimes, etc.).

⑤ Contents of a service using the API are nonscientific or superstitious and they could confuse or

make DOCOMO users uneasy.

⑥ A service using the API induces participation to political organizations, religious organizations or

the like, or requests donations.

⑦ A service using the API uses expressions (subliminal etc.) with normally unperceivable techniques

that work on the subconscious of DOCOMO users.

⑧ Without DOCOMO’s permission, expressions are used as if contents of a service using the API were

recommended or guaranteed by DOCOMO.

⑨ A service using the API could have a significantly negative impact on public morals

⑩ A service using the API could displease a large number of DOCOMO users.

⑪ Contents of a service using the API include images such as nudities that hurt a large number of

DOCOMO users’ sexual feelings. (The images include expressions that suggest sexual acts and

those considered as undressed).

4.4.2. In case a service using the API lacks grace, slanders or brings disgrace on others

A service using the API must not lack grace, slander or bring disgrace on others

< Examples of services using the API that must not be provided>

① Contents of a service using the API could slander, bring disgrace on others, infringe privacy, damage

credit, obstruct business (e.g. For a service aimed at creating a community, no consideration is given

to privacy protection or libelous posting, or the service could easily induce “dating” with unspecified

customers).

② Contents of a service using the API unjustly discriminate or encourage discrimination based on race,

nationality, occupation, gender, circumstances, thoughts, principles, mental or physical handicap, etc.

③ Contents of a service using the API unjustly deny or slander services provided by DOCOMO.

4.4.3. In case a service using the API does not conform to social ethics or violates

regulations

A service using the API must conform to social ethics and must not violate regulations.


17


① Those that could recommend, affirm or encourage crimes and other acts of violating laws (Violation

of the Truth-in-Advertising Laws, Health Promotion Law, Medical Practitioner Law, Pharmaceutical

Business Law, Betting Laws, Act on Specified Commercial Transactions, Act of Settlement of

Funds, etc.).

② Those that buy, sell, etc. obscene products and child porn, and encourage prostitution and child

prostitution. (Violation of Act on Regulation on Soliciting Children by Using Opposite Sex

Introducing Service on Internet, Anti-Prostitution Act, etc.)

③ Photo books etc. photographing children under 15 years old.

④ Those that take a gamble or that could affirm or encourage buying and selling of lotteries. (As for

prize-winning quizzes, DOCOMO may request the developer to submit an attorney’s views report

indicating that care has been taken so as not to excessively increase the prizes and that awarded

prizes are within the scope of the Truth-in-Advertising Laws and they do not constitute a violation

of Betting Laws).

⑤ Those that perform Endless Money Chain and multilevel marketing.

⑥ Those that buy, sell, etc. commodities etc. obtained through theft, robbery, fraud, threat,

embezzlement, breach of trust, etc. (Services with strong ties with categories of business that of ten

perform false advertising of effects and virtues, persistent solicitation, fraud, etc. are also

unacceptable).

⑦ Those that buy, sell, etc. commodities etc. that violate other people’s rights such as patent rights,

utility model rights, design rights, trademark rights, copy rights, portrait rights.

⑧ Those that could affirm or encourage use of stimulant drugs, narcotic drugs, psychotropics,

marijuana, opium, toxic substances or drastic medicine.

⑨ Those that could destroy international friendship.

⑩ Those that use others’ names without authorization

⑪ Those that use names, portraits, trademark rights, copyrighted work without obtaining permission

from rights holders. (As for services that require checking of the contents provisioning agreements

with copy right possessors of publications, rights holders of entertainers, artists and sport

organizations or information delivery rights holders, DOCOMO may ask the developer to submit the

contents provisioning agreements with the information delivery rights holders. In case the news

preset with the RSS reader is provided, please attach the provisioning agreement with the

information delivery rights holders when submitting the application).

⑫ Those that violate or could violate Public Offices Election Act or other laws and regulations.


18

4.4.4. In case a service using the API disturbs sound upbringing of youth

A service using the API must not disturb sound upbringing of youth.


① Those that could excessively encourage a gambling spirit or desire to buy.

② Those that use expressions which affirm or praise antisocial acts such as violence which could

endanger the individual’s life or safety of body without giving consideration to sound upbringing of

youth (A reminder for age limits is required, from the viewpoint of Sex Industry Law etc., for

services that must give consideration to youth).

③ Those that do not take necessary measures such as issuing a warning in advance in case youths

could endanger biological safety of their body through the act of imitation and that have expressions

which defy sound conventional wisdom and are ignoble. (Please refrain from practicing medicine or

providing services that include names of disease to be cured, which could be mistaken for medical

practice), that deal with serious contents extending to suicide and self-injury, e.g. contents and

expressions recommending psychotropics such as suicide manuals and wrist cut, and those that

recommend cosmetic surgery. *As for medical consultation, DOCOMO may request the developer

to submit a statement indicating to the extent that “the Medical Practitioners Law of Health, Labour

and

Welfare Ministry is not violated”.

④ Those expressions that defy sound conventional wisdom and are ignoble in light of sound

upbringing of youth.

4.5. Precautions

[Possibility of changing the basic regulation]

DOCOMO may change this basic regulation based on needs of developers and end users, social

conditions, changes in the environment surrounding DOCOMO, changes in operation policy, etc.

[Cases where DOCOMO refuses the use of the API]

In addition to the above, DOCOMO may refuse developers to use the APIs when it judges

comprehensively that the services cannot be recommended.


19

5. Others (Regarding docomo Developer

support)

5.1. For those who use the APIs for the first time

Usage of the APIs and how applications for usage are submitted are introduced.

5.2. Provide the APIs

Information on how to use the APIs and specifications are presented.

5.3. Development information

Information supporting development of services using the APIs such as FAQs for APIs for each service

etc, latest examples.

5.4. Technology blog

Information useful for developing services using APIs etc. is provided.

5.5. Application procedures and management of API

It is possible to execute application procedures for API keys etc. to be issued and check information of

registered apps. This function can be used on My Page after logging on to the docomo Developer support

site.

5.6. Check and change account information

It is possible to check and change registered account information. This function can be used on My Page

after logging on to the docomo Developer support site.

5.7. Delete accounts

This information deletes account information from docomo Developer support. This function can be used

on My Page after logging on to the docomo Developer support site. Please be aware that the following

will occur after account information is delete.

5.7.1 It will become impossible to log on to My Page of docomo Developer support.

5.7.2 All the registered information will become invalid.


20

5.7.3 All the API functions being registered and used will become unavailable.

5.7.4 All the applications for the APIs, issued API keys, etc. will become invalid the moment the

account information is deleted.

5.8. API Console

You can login to the docomo Developer support portal and access the API console from My

Page section and send API calls to confirm the actual results returned.

5.9. Contact Us /Inquires

Inquires on APIs and service development for smartphones are accepted. This function can be used on

My Page after logging on to the docomo Developer support site.