Developer Center (English) > Startup Guide > Authentication and Access

ここから本文です
        

Authentication and Access

Sponsored Search API and YDN API provides two types of authentication.
- Authentication: Agency and Advertiser of Yahoo! JAPAN Promotional Ads to operate their own account.
- On-Behalf-Of authentication: For Third party Tool to access other users account.

Authentication differ to what kind of account you want to access.

SOAP Header of request

The SOAP header contains authentication information of API system and account.
Please refer to SoapHeader object for header information details.

Authentication

If you are a user making a request, for example, you are the advertiser or agency, the SOAP header includes these elements:

Field Description
license A license number issued by Yahoo! JAPAN.
Please input in "xxxx-xxxx-xxxx-xxxx" form.
apiAccountId An API Account ID issued by Yahoo! JAPAN for API system authentication.
Please input in "xxxx-xxxx-xxxx-xxxx" form.
apiAccountPassword A password set by the user with the API management tool for an API Account ID.


Request Sample
Sponsored Search API V201805

<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope
  xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
  xmlns:ns1="http://ss.yahooapis.jp/V201805/Account">
      <SOAP-ENV:Header>
          <ns1:RequestHeader>
              <ns1:license>xxxxxxxxxxxxxxx</ns1:license>
              <ns1:apiAccountId>xxxxxxxxxxxxxxxxxx</ns1:apiAccountId>
              <ns1:apiAccountPassword>passwd</ns1:apiAccountPassword>
          </ns1:RequestHeader>
      </SOAP-ENV:Header>
      <SOAP-ENV:Body>
      ...
      </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Before Sponsored Search API version 6.5

<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope
  xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
  xmlns:ns1="http://ss.yahooapis.jp/V6">
      <SOAP-ENV:Header>
          <ns1:RequestHeader>
              <ns1:license>xxxxxxxxxxxxxxx</ns1:license>
              <ns1:apiAccountId>xxxxxxxxxxxxxxxxxx</ns1:apiAccountId>
              <ns1:apiAccountPassword>passwd</ns1:apiAccountPassword>
          </ns1:RequestHeader>
      </SOAP-ENV:Header>
      <SOAP-ENV:Body>
      ...
      </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

YDN API V201806

<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope
  xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
  xmlns:ns1="http://im.yahooapis.jp/V201806/Account">
      <SOAP-ENV:Header>
          <ns1:RequestHeader>
              <ns1:license>xxxxxxxxxxxxxxx</ns1:license>
              <ns1:apiAccountId>xxxxxxxxxxxxxxxxxx</ns1:apiAccountId>
              <ns1:apiAccountPassword>passwd</ns1:apiAccountPassword>
          </ns1:RequestHeader>
      </SOAP-ENV:Header>
      <SOAP-ENV:Body>
      ...
      </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Before YDN API version 6.1

<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope
  xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
  xmlns:ns1="http://im.yahooapis.jp/V6">
      <SOAP-ENV:Header>
          <ns1:RequestHeader>
              <ns1:license>xxxxxxxxxxxxxxx</ns1:license>
              <ns1:apiAccountId>xxxxxxxxxxxxxxxxxx</ns1:apiAccountId>
              <ns1:apiAccountPassword>passwd</ns1:apiAccountPassword>
          </ns1:RequestHeader>
      </SOAP-ENV:Header>
      <SOAP-ENV:Body>
      ...
      </SOAP-ENV:Body>
</SOAP-ENV:Envelope>


On-Behalf-Of authentication

If you are a third party that offers external operation tool, who wants to access to the account on behalf of agencies and/or advertisers, account authentication via API access (Application account) will be required.
Each application account have to be created by the account owner (Agency or advertiser).

Field Description
license A license number issued by Yahoo! JAPAN.
Please input in "xxxx-xxxx-xxxx-xxxx" form.
apiAccountId An API Account ID issued by Yahoo! JAPAN for API system authentication.
Please input in "xxxx-xxxx-xxxx-xxxx" form.
apiAccountPassword A password set by the user with the API management tool for an API Account ID.
accountId Sponsored Search or Yahoo! JAPAN Display Ads Network account ID for access via API.
An external operation tool is needed for accessing in place of another user, such as an agency or advertiser.
onBehalfOfAccountId An API access exclusive account ID (Application Account ID) for accessing an account ID from an application.
An external operation tool is needed for accessing in place of another user, such as an agency or advertiser.
onBehalfOfPassword A password set to the Application Account ID (onBehalfOfAccountId).
An external operation tool is needed for accessing in place of another user, such as an agency or advertiser.


Request Sample
Sponsored Search API version 201805

<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope
  xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
  xmlns:ns1="http://ss.yahooapis.jp/V201805/Account">
      <SOAP-ENV:Header>
          <ns1:RequestHeader>
              <ns1:license>xxxxxxxxxxxxxxx</ns1:license>
              <ns1:apiAccountId>xxxxxxxxxxxxxxxxxx</ns1:apiAccountId>
              <ns1:apiAccountPassword>passwd</ns1:apiAccountPassword>
              <ns1:accountId>1000000001</ns1:accountId>
              <ns1:onBehalfOfAccountId>xxxxxxxxxxxxxx</ns1:onBehalfOfAccountId>
              <ns1:onBehalfOfPassword>passwd2</ns1:onBehalfOfPassword>
          </ns1:RequestHeader>
      </SOAP-ENV:Header>
      <SOAP-ENV:Body>
      ...
      </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Before Sponsored Search API version 6.5

<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope
  xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
  xmlns:ns1="http://ss.yahooapis.jp/V6">
      <SOAP-ENV:Header>
          <ns1:RequestHeader>
              <ns1:license>xxxxxxxxxxxxxxx</ns1:license>
              <ns1:apiAccountId>xxxxxxxxxxxxxxxxxx</ns1:apiAccountId>
              <ns1:apiAccountPassword>passwd</ns1:apiAccountPassword>
              <ns1:accountId>1000000001</ns1:accountId>
              <ns1:onBehalfOfAccountId>xxxxxxxxxxxxxx</ns1:onBehalfOfAccountId>
              <ns1:onBehalfOfPassword>passwd2</ns1:onBehalfOfPassword>
          </ns1:RequestHeader>
      </SOAP-ENV:Header>
      <SOAP-ENV:Body>
      ...
      </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

YDN API version 201806

<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope
  xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
  xmlns:ns1="http://im.yahooapis.jp/V201806/Account">
      <SOAP-ENV:Header>
          <ns1:RequestHeader>
              <ns1:license>xxxxxxxxxxxxxxx</ns1:license>
              <ns1:apiAccountId>xxxxxxxxxxxxxxxxxx</ns1:apiAccountId>
              <ns1:apiAccountPassword>passwd</ns1:apiAccountPassword>
              <ns1:accountId>1000000001</ns1:accountId>
              <ns1:onBehalfOfAccountId>xxxxxxxxxxxxxx</ns1:onBehalfOfAccountId>
              <ns1:onBehalfOfPassword>passwd2</ns1:onBehalfOfPassword>
          </ns1:RequestHeader>
      </SOAP-ENV:Header>
      <SOAP-ENV:Body>
      ...
      </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Before YDN API version 6.1

<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope
  xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
  xmlns:ns1="http://im.yahooapis.jp/V6">
      <SOAP-ENV:Header>
          <ns1:RequestHeader>
              <ns1:license>xxxxxxxxxxxxxxx</ns1:license>
              <ns1:apiAccountId>xxxxxxxxxxxxxxxxxx</ns1:apiAccountId>
              <ns1:apiAccountPassword>passwd</ns1:apiAccountPassword>
              <ns1:accountId>1000000001</ns1:accountId>
              <ns1:onBehalfOfAccountId>xxxxxxxxxxxxxx</ns1:onBehalfOfAccountId>
              <ns1:onBehalfOfPassword>passwd2</ns1:onBehalfOfPassword>
          </ns1:RequestHeader>
      </SOAP-ENV:Header>
      <SOAP-ENV:Body>
      ...
      </SOAP-ENV:Body>
</SOAP-ENV:Envelope>


Regarding authentication of Sandbox

For authentication or access to Sandbox, please refer from Sandbox page.

        
Text ends here Top of page