Everything You Need to Know About API Configuration

First of all, what is an API Configuration?


APIs permit individuals to make applications that interface with the framework or make new applications/UIs on top of existing frameworks. An API is communicated as far as its tasks, information sources, yields, and basic sorts, characterizing functionalities that are autonomous of their individual executions. A decent API makes it simpler to foster a program by giving all the structure blocks, which are then assembled.


The configuration API gives a focal spot to modules to store configuration information. This information can be basic configuration like your site name, or more mind-boggling data dealt with configuration elements, like perspectives and substance types.

Configuration is a spot to store data that you would need to synchronize from improvement to creation. This data is frequently made during site-constructing and isn\’t ordinarily created by standard clients during ordinary site activity.

You should utilize the State API, not configuration, for putting away neighborhood factors that shouldn\’t go between cases. Use state for covered up framework esteems, and on the off chance that you never need to convey it between conditions. You can reset a framework, losing all state. Its configuration remains.

The configuration API comes in two flavors – the (simple) Config API and the Configuration (advanced) Entity API. ~The key contrast is that the Config API is the singleton use case.

A singleton is a place where there can be just a solitary occurrence of this configuration. A genuine model would be the site\’s name.

The Configuration Entity API ought to be utilized to store various arrangements of configuration – for instance hub types, perspectives, vocabularies, and fields.

Refreshing the configuration API is crucial to stay away from lethal blunders when refreshing topics and modules to work.

Now, let us dive into the depths of API Configuration.

How To Create/Open an API Configuration?

Making an API config

  • Prerequisites

Before you can make an API config, guarantee that you have: Arranged your development environment as depicted in Configuring your development environment. Made an API definition as an OpenAPI spec.

Alternatively made an API as portrayed in Creating an API. In the event that the API doesn\’t as of now exist, making the API config makes it.

~API config ID necessities:

A considerable lot of the gcloud orders appeared underneath expect you to specify the ID of the API config, in the structure: CONFIG_ID. API Gateway implements the accompanying necessities for the API config ID:

  • Should have the greatest length of 63 characters.
  • Should contain just lowercase letters, numbers, or dashes.
  • Should not begin with a dash.
  • Should not contain an underscore.
  • To make an API config:
  • Change registry to the index containing your API definition.

For more on making the OpenAPI spec for your API definition, see OpenAPI outline and QuickStart: Deploy an API on API Gateway.

For more on making a gRPC administration definition and configuration for your API definition, see Configuring a gRPC administration and getting started with API Gateway and Cloud Run for gRPC.

  • Validate the task ID got back from the accompanying order to ensure that the help isn\’t made in some unacceptable undertaking.

On the off chance that you need to change the default project, run the accompanying order and replace PROJECT_ID with the Google Cloud project ID in which you need to make the assistance:

gcloud config set task PROJECT_ID

  • View help for the api-configs make order:

gcloud api-gateway api-configs make – help

  • Run the accompanying order to make the API config:

gcloud api-gateway api-configs make CONFIG_ID \\

– api=API_ID – OpenAPI-spec=API_DEFINITION \\

– project=PROJECT_ID – backend-auth-administration account=SERVICE_ACCOUNT_EMAIL

~where: CONFIG_ID specifies the ID of the new API config.

API_ID specifies the ID of the API Gateway API related with this API config. On the off chance that the API doesn\’t as of now exist, this order makes it.

API_DEFINITION specifies the name of the OpenAPI spec containing the API definition.

PROJECT_ID specifies the Google Cloud project ID.

SERVICE_ACCOUNT_EMAIL specifies the help account made unequivocally for making API configs. See Configuring an assistance represent more subtleties.

As it is making the API and API config, API Gateway yields data to the terminal.

This activity may require a few minutes to finish as the API config is engendered to downstream frameworks.

Formation of an unpredictable API config could require as long as ten minutes to finish effectively.

  • On successful completion, you can utilize the accompanying order to see insights concerning the new API config:

gcloud api-gateway api-configs portray CONFIG_ID \\

– api=API_ID – project=PROJECT_ID

This order returns the accompanying:

createTime: \’2020-02-04T18:33:11.882707149Z\’

displayName: CONFIG_ID



googleServiceAccount: 1111111@developer.gserviceaccount.com

marks: \’\’

name: projects/PROJECT_ID/areas/worldwide/apis/API_ID/configs/CONFIG_ID


rolloutId: 2020-02-04r2

state: ACTIVE

update Time: \’2020-02-04T18:33:12.219323647Z\’

Empower the API:

gcloud administrations empower API_ID-HASH.apigateway.PROJECT_ID.cloud.goog

You possibly need to run this order once when you make the API. In the event that you later change the API, you don\’t need to rerun the order.

The gcloud order line apparatus takes numerous alternatives, incorporating those portrayed in the gcloud reference. Likewise, for API Gateway, you can set the accompanying alternatives while making an API config:

async: Return control to the terminal promptly, without trusting that the activity will finish.

show name=NAME: Specifies the showcase name of the API config, which means the name appeared in the UI. Try not to utilize spaces in the name. Use hyphens and highlights all things considered. The default esteem is CONFIG_ID.

labels=KEY1=VALUE1,KEY2=VALUE2,…: Specifies names related with the API config.

For instance:

gcloud api-gateway api-configs make CONFIG_ID \\

api=API_ID – openapi-spec=API_DEFINITION \\

project=PROJECT_ID – backend-auth-administration account=SERVICE_ACCOUNT_EMAIL \\

async – show name=MyConfig – labels=a=1,b=2

You can see the marks in the yield of the depict order appeared above, or in the rundown order by including the – format choice:

gcloud api-gateway api-configs list \\

– api=API_ID – project=PROJECT_ID – format=\”table(name, marks)\”

Read Also


How To Use an API Configuration?

The Configuration API is composed by OpenAPI norms, and empowers end clients to see documentation for the API utilizing their favored OpenAPI device, like Swagger, Postman, or RediDoc.

You can either see the Configuration API documentation straightforwardly in the item (/login), or download the YAML record and utilize a device of your choice to see the documentation.

View the Configuration API Documentation in/login.

Access Configuration API Documentation straightforwardly from/login.

Sign in to your site (for instance, https://example.com/login/apidocs.html) and enter your certifications. You can discover records, depictions, and models for all accessible APIs.

  • View Configuration API Documentation

You can tap the connection to see the in-item Config API documentation.

  • Access the YAML record through API

~By following the means underneath and alluding to the documentation for your preferred OpenAPI instrument, you can see the API documentation and even evaluate highlights of the API utilizing a natural program UI.

Go to/login > Management > API Configuration.

Under API Accounts, click Add.

Enter one name to detect your new API account.

Ensure the Configuration API > Allow Access box is checked.

Click Save.

Download and introduce your number one programming for running API calls. If it\’s not too much trouble, allude to the documentation for your chose programming prior to continuing, if necessary.

In/login > Management > API Configuration, select the new API account you just made and click the alter symbol.

Duplicate the OAuth Client ID and glue it into your chose programming.

Back in/login, click Generate New Client Secret, duplicate it, and glue it into you chose programming.

Click Save to save your API account.

Import the OpenAPI.yaml record from your site, utilizing your favored OpenAPI apparatus.

The OpenAPI.yaml document can be accessed by making another GET demand with the URL design https://example.com/api/config/v1/openapi.yaml.

When imported, the documentation for the Configuration APIs will be consequently produced. Adhere to the directions in your API call programming to finish these means.

  • Download the YAML document

Then again, you can download the YAML record by tapping the Download the Configuration API\’s OpenAPI YAML document.

Checking API’s Proxy Deployment Status

  • Check your API intermediary\’s arrangement status utilizing the API

This segment portrays how to check the sending status of an API intermediary utilizing the Apigee APIs.

1. Send a test API intermediary as clarified in Create and convey another API intermediary.

2. Find the JSON document with the Apigee Organization Admin administration account key. This assistance record and key was made in Enable synchronizer access.

  • Execute these two orders to get a token:

send out GOOGLE_APPLICATION_CREDENTIALS=org-administrator administration account-record

trade TOKEN=$(gcloud auth application-default print-access-token)

Where organization administrator administration account-record is the way on your framework to the assistance account key you downloaded with the Apigee Organization Admin job.

  • Call the corrections API, with the accompanying parts:

Base URL: https://apigee.googleapis.com/v1

Endpoint URL:/associations/my-association/surroundings/test/apis/myproxy/corrections/1/arrangements

Convention: HTTPS

Strategy: GET

Headers: \”Approval: Bearer $TOKEN\”

The accompanying model calls the arrangement modifications API with these settings utilizing twist:

twist \”https://apigee.googleapis.com/v1/associations/my-association/surroundings/test/apis/myproxy/modifications/1/organizations\” \\

– X GET – H \”Approval: Bearer $TOKEN\”

You ought to get a reaction like the accompanying:


\”climate\”: \”test\”,

\”apiProxy\”: \”myproxy\”,

\”amendment\”: \”1\”,

\”deployStartTime\”: \”1616787712821\”,

\”state\”: \”Prepared\”,

\”examples\”: [


\”example\”: \”hybrid-docs-id\”,

\”deployedRevisions\”: [


\”update\”: \”2\”,

\”rate\”: 100



\”deployedRoutes\”: [


\”basepath\”: \”/myproxy\”,

\”envgroup\”: \”test-bunch\”,

\”climate\”: \”test\”,

\”rate\”: 100






This model reaction shows the API intermediary\’s status is READY, demonstrating an effective sending.

On the off chance that you get an empty reaction or a blunder, watch that:

  • You utilized the right base URL. Note that the hybrid base URL isn\’t equivalent to the Edge API\’s base URL. Use https://apigee.googleapis.com/v1.
  • You utilized the right endpoint URL. Note that the update is \”1\” and the endpoint is/associations/my_organization/conditions/test/apis/myproxy/corrections/1/arrangements.
  • On the off chance that you specify a modification that doesn\’t exist, the solicitation brings about a vacant reaction like the accompanying:

{ }

  • You have consents to get to the association that you specify in the solicitation.
  • Your token has not terminated. On the off chance that it has, recover another one as portrayed in Obtain an OAuth 2.0 access token.
  • You wrapped the \”Approval: Bearer $TOKEN\” header in cites.


So, a class like this (C++ header)

class MyClass



explicit MyClass( std::string and s );


int doSomething( int j );


Would guide to a C interface like this (C header):

struct HMyClass;/An obscure kind that we\’ll use as a handle

typedef struct HMyClass;

HMyClass * myStruct_create( const scorch * s );

void myStruct_destroy( HMyClass * v );

int myStruct_doSomething( HMyClass * v, int I );

The execution of the interface would resemble this (C++ source)

#include \”MyClass.h\”

extern \”C\”


HMyClass * myStruct_create( const singe * s )


return reinterpret_cast<HMyClass*>( new MyClass( s ) );


void myStruct_destroy( HMyClass * v )


erase reinterpret_cast<MyClass*>(v);


int myStruct_doSomething( HMyClass * v, int I )


return reinterpret_cast<MyClass*>(v)- >doSomething(i);




~Since APK files are mainly used on Android Platforms, we will look at How to Open an APK File on Android:

  • For opening an APK record on an Android gadget, simply download it and open it when inquired.
  • Notwithstanding, as a result of the wellbeing blocks, some of the time APK documents that are endeavored to introduce outside the Play Store don\’t move introduced immediately.
  • For bypassing this downloading limitation and introducing them from obscure sources, not many settings should be changed.
  • Contingent upon the Android rendition, here are a few different ways to can open an APK record.
  • From settings, explore to applications and notices alternative.
  • At that point select the high level choice and snap on special application access. At last, select introduce obscure applications choices.
  • From settings, go to applications and notices.
  • From settings, explore to security alternatives.
  • You may have to give a specific application authorization to introduce the informal APK documents.
  • Or then again, you may see the alternative, empower introduce obscure sources or obscure applications. In the event that it actually doesn\’t open, you may require a record director.


  • ResponseEntity add custom headers

ResponseEntity gives an alternative to set custom headers accordingly. To add custom headers, you need to make an object of HttpHeaders bean and afterward you set quite a few headers into your reaction.

In the accompanying model, we are setting one custom header named \”technicalsand-Example-Header\” into reaction, with esteem \”https://technicalsand.com\”.


public ResponseEntity exampleHeaders() {

HttpHeaders responseHeaders = new HttpHeaders();

responseHeaders.set(\”technicalsand-Example-Header\”, \”https://technicalsand.com\”);

return ResponseEntity.ok(\”success\”,).headers(responseHeaders).build();


What are a few kinds of API utilized?

There are 3 sorts of APIs utilized normally today:

~Open API

~Partner API

~Private API

Open APIs are publicly accessible for anybody to utilize. BigCommerce, for instance, utilizes about 25 diverse APIs, which is accessible for the general population to utilize.

Partner APIs are planned by organizations to offer API admittance to key colleagues as an additional income channel for the two players.

For instance, Ticketmaster offers a Partner API to permit its customers the capacity to hold, purchase, and recover ticket/occasion data.

Private APIs are not intended for public use and are intended for inside use.

Suppose you are going to an alternate city for a conference. You need to make a speedy outing to the bank. You stroll into \”ABC Bank\” and give the teller your record number.

She rapidly pulls up your record and you make a withdrawal.

The teller had the option to pull up your data by utilizing ABC\’s inside framework, which utilizes an API to pull your record data and to refresh your new record balance.

Conclusion to API Configuration:

API is an incredible asset that can help accelerate your business activities, develop your image\’s range, associate your customers to the items they need, thus substantially more.

If you’re really keen in known about APIs in a detailed way, do go through this article thoroughly.

It has been personally curated for all those who are really into knowing what it takes to completely understand the concept of API.

Happy Learning!

About The Author

Leave a Comment

Your email address will not be published. Required fields are marked *

Scroll to Top