WebAPI

A Schema.org Type

This term is in the "new" area - implementation feedback and adoption from applications and websites can help improve our definitions.

Thing > Intangible > Service > WebAPI

[more...]

Canonical URL: https://schema.org/WebAPI
Check for open issues.

An application programming interface accessible over Web/Internet technologies.

Property	Expected Type	Description
Properties from WebAPI
`documentation`	CreativeWork or URL	Further documentation describing the Web API in more detail.
Properties from Service
`aggregateRating`	AggregateRating	The overall rating, based on a collection of reviews or ratings, of the item.
`areaServed`	AdministrativeArea or GeoShape or Place or Text	The geographic area where a service or offered item is provided. Supersedes serviceArea.
`audience`	Audience	An intended audience, i.e. a group for whom something was created. Supersedes serviceAudience.
`availableChannel`	ServiceChannel	A means of accessing the service (e.g. a phone bank, a web site, a location, etc.).
`award`	Text	An award won by or for this item. Supersedes awards.
`brand`	Brand or Organization	The brand(s) associated with a product or service, or the brand(s) maintained by an organization or business person.
`broker`	Organization or Person	An entity that arranges for an exchange between a buyer and a seller. In most cases a broker never acquires or releases ownership of a product or service involved in an exchange. If it is not clear whether an entity is a broker, seller, or buyer, the latter two terms are preferred. Supersedes bookingAgent.
`category`	CategoryCode or PhysicalActivityCategory or Text or Thing or URL	A category for the item. Greater signs or slashes can be used to informally indicate a category hierarchy.
`hasCertification`	Certification	Certification information about a product, organization, service, place, or person.
`hasOfferCatalog`	OfferCatalog	Indicates an OfferCatalog listing for this Organization, Person, or Service.
`hoursAvailable`	OpeningHoursSpecification	The hours during which this service or contact is available.
`isRelatedTo`	Product or Service	A pointer to another, somehow related product (or multiple products).
`isSimilarTo`	Product or Service	A pointer to another, functionally similar product (or multiple products).
`logo`	ImageObject or URL	An associated logo.
`offers`	Demand or Offer	An offer to provide this item—for example, an offer to sell a product, rent the DVD of a movie, perform a service, or give away tickets to an event. Use businessFunction to indicate the kind of transaction offered, i.e. sell, lease, etc. This property can also be used to describe a Demand. While this property is listed as expected on a number of common types, it can be used in others. In that case, using a second type, such as Product or a subtype of Product, can clarify the nature of the offer. Inverse property: itemOffered
`provider`	Organization or Person	The service provider, service operator, or service performer; the goods producer. Another party (a seller) may offer those services or goods on behalf of the provider. A provider may also serve as the seller. Supersedes carrier.
`providerMobility`	Text	Indicates the mobility of a provided service (e.g. 'static', 'dynamic').
`review`	Review	A review of the item. Supersedes reviews.
`serviceOutput`	Thing	The tangible thing generated by the service, e.g. a passport, permit, etc. Supersedes produces.
`serviceType`	GovernmentBenefitsType or Text	The type of service being offered, e.g. veterans' benefits, emergency relief, etc.
`slogan`	Text	A slogan or motto associated with the item.
`termsOfService`	Text or URL	Human-readable terms of service documentation.
Properties from Thing
`additionalType`	Text or URL	An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. Typically the value is a URI-identified RDF class, and in this case corresponds to the use of rdf:type in RDF. Text values can be used sparingly, for cases where useful information can be added without their being an appropriate schema to reference. In the case of text values, the class label should follow the schema.org style guide.
`alternateName`	Text	An alias for the item.
`description`	Text or TextObject	A description of the item.
`disambiguatingDescription`	Text	A sub property of description. A short description of the item used to disambiguate from other, similar items. Information from other properties (in particular, name) may be necessary for the description to be useful for disambiguation.
`identifier`	PropertyValue or Text or URL	The identifier property represents any kind of identifier for any kind of Thing, such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for representing many of these, either as textual strings or as URL (URI) links. See background notes for more details.
`image`	ImageObject or URL	An image of the item. This can be a URL or a fully described ImageObject.
`mainEntityOfPage`	CreativeWork or URL	Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See background notes for details. Inverse property: mainEntity
`name`	Text	The name of the item.
`owner`	Organization or Person	A person or organization who owns this Thing. Inverse property: owns
`potentialAction`	Action	Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role.
`sameAs`	URL	URL of a reference Web page that unambiguously indicates the item's identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or official website.
`subjectOf`	CreativeWork or Event	A CreativeWork or Event about this Thing. Inverse property: about
`url`	URL	URL of the item.

Source

https://github.com/schemaorg/schemaorg/issues/1423

Examples

Example 1

No Markup JSON-LD Structure

Example notes or example HTML without markup.

See JSON example.

Example encoded as JSON-LD in a HTML script tag.

<script type="application/ld+json">
{
  "@context": "https://schema.org/",
  "@type": "WebAPI",
  "name": "Google Knowledge Graph Search API",
  "description": "The Knowledge Graph Search API lets you find entities in the Google Knowledge Graph. The API uses standard schema.org types and is compliant with the JSON-LD specification.",
  "documentation": "https://developers.google.com/knowledge-graph/",
  "termsOfService": "https://developers.google.com/knowledge-graph/terms",
  "provider": {
    "@type": "Organization",
    "name": "Google Inc."
  }
}
</script>

Structured representation of the JSON-LD example.