API FAQ

What is FUJITSU Cloud Service K5 API Management?
FUJITSU Cloud Service K5 API Management is a gateway service of web api and a part of PaaS in FUJITSU Cloud Service K5.

API Management is a service that gives value to service providers of web api and users who are planning to add the interface of web api on their system.
API Management takes the position between the web api service and the client who uses the service, and plays a role as gateway.
API Management has several functions, such as traffic management, authentication, security, mediation, etc. Not only can you realize the functions in your web api by calling a web api via API Management, but you can develop the web api itself.
Why use FUJITSU Cloud Service K5 API Management?
FUJITSU Cloud Service K5 API Management provides users with the following advantages.
   ✓ API Management allows you to add functionality without coding, so that you can reduce the development cost of web api.
   ✓ API Management provides you with the development functions, debug, deploy, test environment so that you can develop efficiently.
   ✓ API Management helps you improve the performance of your APIs, detect error and check usage by monitoring several statistics about API graphically.
   ✓ API Management helps you provide flexible API product that matches to your business plan by api packaging function.
Do I have to access by a different URL from my current API’s URL by using API Management?
You may be able to use your current API’s URL by using your own domain name rather than default domain".paas.cloud.global.fujitsu.com". Please use the K5 help desk to contact us if you wish to use of your domain.
You have to do the following if you use a custom domain.
   ✓ You have to add CNAME record to your DNS server to specify that your domain name is an alias for our default domain.
   ✓ You have to provide us with SSL certificate if you use HTTPS.
Can I use HTTPS when calling API?
Yes. You can use HTTP and HTTPS.
Do I have to add anything to an API request?
No need.
API Management doesn't let you add anything data to query, header and body.
What data format can I use for my API's payloads?
You can use any content type include JSON, XML for your API's payloads.
How much do API's responses slow via API Management?
It depends on the number of policy added to the API and the weight of the policy process.
With what backends can API Management communicate?
API Management can communicate with the HTTP based services that are accessible via the public
Internet.
For which client platforms does API Management provide SDKs?
API Management doesn't provide SDKs.
API Management doesn't make a change in the specification of API request and response.
Therefore, you can use the general library provided for each development language.
What functions can I add to my API with API Management?
You can add the function which roughly divided into four types to API.
TRAFFIC MANAGEMENT
  ✓   Limits on the number of API calls made over an interval of time
  ✓   Throttles inbound connections from API to backend services
  ✓   Cache(Response Data / Any data included in payloads)
MEDIATION
  ✓   Conversion of data format
  ✓   Modificaton of HTTP request or response messages
SECURITY
  ✓   Basic Authentication
  ✓   OAuth
  ✓   Verification of API Key
  ✓   Access permission to API by IP addresses
  ✓   Minimization of the risk posed by content-level attacks
EXTENSION
  ✓   Execution of custom JavaScript code
  ✓   Data mashup of response data from multiple backends
Can I monitor the usage of API?
Yes. API Management provides you with Analytics function to monitor API calls.
Analytics provides you with the following:
  ✓   Number of response
  ✓   Response time
  ✓   Rate of API calls hitting cache
  ✓   Statistics of response errors
  ✓   Statistics by client calls API
Analytics provides you with grouping, filter, drill-down chart so that you can monitor detailed statistics.
Can I set up alarms on the API Management metrics?
No. API Management doesn't provide auto monitoring function including alert.
I receive an "Unknown username and password combination" when I log in.
You see this message in case of the following.
  ✓   Invalid username or password
        -> Please enter a valid value
  ✓   Your account is locked by consecutively erroneous in the login authentication
        -> Your account is unlocked after an elapse of thirteen minutes
  ✓   Password expired
        -> Please reissue password from "Forgot your password" on Login page
Can I check the charge status?
API Management rates are calculated from the total number of API request.
You can check the total number of API request in the following steps.
Here is example which checks the total number of API request from Dec.28 to the last 3 months(Sep.28 9:00 am - Dec.28 9:00 am).

1. Log in to API Management.
faq_api_00014a.png


2. Click Custom button on Dashboard page.
faq_api_00014b.png


3. You can see a calendar of the last three months
Note:
You can't select the range of more than a month in the calendar, so you need to check in 3 parts to check data for the last three months.
faq_api_00014c.png


4. Click date in the order of start date(Nov.29), end date(Dec.28) to check data for the last month.
Note:
API Management displays the data from the day before the start date which you selected, so click Nov.29 which is the following day of Nov.28 in this case.
faq_api_00014d.png


5. In TOTAL TRAFFIC you can see the total number of API request from Nov.28 9:00 am to Dec.28 9:00 am.
faq_api_00014e.png


6. Repeat the above steps on the period from 2 months ago(Oct.28-Nov.28) and on the period from 3 month ago(Sep.28-Oct.28).
With three month data included, you can get the total number of API request for 3 months.
Note:
If you select the range of less than 9 days in the calendar, the scale on graph changes from day to hour and start time changes from 9:00 am to 0:00 am.
by day(select the range of more than 9 days in the calendar): Nov.28 9:00 am - Dec.28 9:00 am by hour(select the range of less than 9 days): Dec.25 0:00 am - Dec.28 11:00 pm
Even if you select the range of less than 9 days, you can change start date from 0:00 am to 9:00 am by selecting By Day.
faq_api_00014f.png
Is the subscription canceled at the time of requesting the cancelation of service?
Monthly fixed charge is stopped at the time of requesting the cancelation of service. So it won't incur fixed charge of the next month.

However the API called for up to 3 working days from the day of requesting the cancelation of service is considered an API call for billing purposes. If you exceed the number of calls included in monthly fixed charge tier during the period, you will be charged the rates of excess option. If you undeploy all API Proxies in order to block the API before requesting the cancelation of service, you will avoid this.

e.g. If you request the cancelation of service at 6/15/2016 23:00 UTC,
  ✓   Monthly fixed charge: you will be charged up to June.
  ✓   API call: the API called for up to 6/20/2016 Mon(6/18 and 6/19 is holiday) are counted.
What is difference from API Management Pro and API Management Standard?
It is about the different number of API calls included in monthly fixed charge and contract period. The analytics function is also different.

- API calls

Service Name

API calls

Reset period

Rates if exceed

API Management Pro

25 million

3 month

2.5 million

API Management Standard 3M

3 million

 

1 month

 

1 million

API Management Standard 10M

10 million

API Management Standard 20M

20 million


- Supported Analytics

Analytics reports

Pro

Standard

Proxy Performance

Target Performance

×

Cache Performance

Latency Analysis

Error Analysis

Developer Engagement

Traffic Composition

Business Transactions

Devices

Custom Reports

△(*1)


(*1) Only a part of Metrics/Dimension
Can I change my contract plan? (e.g. Change from API Management Pro to API Management Standard)
Yes.

Change type

Change method

When will it be changed?

Service change
#Change between API Management Pro and API Management Standard

Use the help desk to contact us.#1

  • If you request plan change by the 20th, then next month.
  • If you request plan change after the 21th, then the month after next.

Plan change in API Management Standard
#Plan change among 3M/10M/20M

You can change on K5 PaaS Portal.

  • Change during trial period
    ->The next day of day which requested plan change.
  • Change during paid period(after trial)
    ->The next month of day which requested plan change.

#1 Please fill out the form by the following content when you contact us.

item

content

example

Title

Request for catalog change in API Management

Content

- Service name after the change
- The month on which you want to start service after the change

Service name after the change: API Management Standard 3M The month on which you want to start service after the change: 9/2016