isbndb
Module isbndb
API
![](https://bcentral-dev-packageicons.azureedge.net/images/ballerinax_isbndb_1.5.1.png)
ballerinax/isbndb Ballerina library
Overview
This is a generated connector for ISBNdb API v2.0.0 OpenAPI specification.
The ISBNdb.com API exposes data such as title, author, publisher and publish date about books.
Clients![](/images/permalink.svg)
isbndb: Client![](/images/permalink.svg)
This is a generated connector for ISBNdb API v2.0.0 OpenAPI specification. The ISBNdb.com API exposes data such as title, author, publisher and publish date about books.
Constructor![](/images/permalink.svg)
Gets invoked to initialize the connector
.
The connector initialization requires setting the API credentials.
Create a ISBNdb Account by selecting a pricing plan and obtain tokens following this guide.
init (ApiKeysConfig apiKeyConfig, ConnectionConfig config, string serviceUrl)
- apiKeyConfig ApiKeysConfig - API keys for authorization
- config ConnectionConfig {} - The configurations to be used when initializing the
connector
- serviceUrl string "https://api2.isbndb.com/" - URL of the target service
getAuthorDetails![](/images/permalink.svg)
Gets author details
Parameters
- name string - The name of an author in the Author's database
- page int (default 1) - The number of page to retrieve, please note the API will not return more than 10,000 results no matter how you paginate them
- pageSize int (default 20) - How many items should be returned per page, maximum of 1,000
searchAuthors![](/images/permalink.svg)
function searchAuthors(string query, string? pageSize, string? page) returns AuthorQueryResults|error
Search authors
Parameters
- query string - A string to search for in the Author’s database
- pageSize string? (default ()) - How many items should be returned per page, maximum of 1,000
- page string? (default ()) - The number of page to retrieve, please note the API will not return more than 10,000 results no matter how you paginate them
Return Type
- AuthorQueryResults|error - The query string found results in the author's database
getBookDetails![](/images/permalink.svg)
Gets book details
Parameters
- isbn string - an ISBN 10 or ISBN 13 in the Books database
- withPrices string? (default ()) - indicate if shows Real Time Prices. Only with the Pro plan
searchBooks![](/images/permalink.svg)
Search books
Parameters
- payload BooksBody - Request payload to search to search books
searchBooksByQuery![](/images/permalink.svg)
function searchBooksByQuery(string query, int page, int pageSize, string? column, int beta) returns Response|error
Search books
Parameters
- query string - A string to search for in the Book’s database
- page int (default 1) - The number of page to retrieve, please note the API will not return more than 10,000 results no matter how you paginate them
- pageSize int (default 20) - How many items should be returned per page, maximum of 1,000
- column string? (default ()) - Search limited to this column: *
- Empty value search in every column * `title` - Only searches in Books Title * `author` - Only searches books by the given Author * `date_published` - Only searches books in a given year, e.g. 1998 MISSING[
]+ beta - A integer (1 or 0) for enable or disable beta searching.- return - The query string found results in the books's database
- beta int (default 0) -
getPublisherDetails![](/images/permalink.svg)
Gets publisher details
Parameters
- name string - The name of a publisher in the Publisher's database
- page int (default 1) - The number of page to retrieve, please note the API will not return more than 10,000 results no matter how you paginate them
- pageSize int (default 20) - How many items should be returned per page, maximum of 1,000
searchPublishers![](/images/permalink.svg)
Search publishers
Parameters
- query string - A string to search for in the Publisher’s database
- pageSize string? (default ()) - How many items should be returned per page, maximum of 1,000
- page string? (default ()) - The number of page to retrieve, please note the API will not return more than 10,000 results no matter how you paginate them
searchISBNDB![](/images/permalink.svg)
function searchISBNDB(string index, string? page, string? pageSize, string? isbn, string? isbn13, string? author, string? text, string? subject, string? publisher) returns Response|error
Search all ISBNDB databases
Parameters
- index string - Only this values are valids: subjects, publishers, authors y books
- page string? (default ()) - The number of page to retrieve, please note the API will not return more than 10,000 results no matter how you paginate them
- pageSize string? (default ()) - How many items should be returned per page, maximum of 1,000
- isbn string? (default ()) - an ISBN 10 in the Books database
- isbn13 string? (default ()) - an ISBN 13 in the Books database
- author string? (default ()) - The name of an author in the Author's database
- text string? (default ()) - A string to search for determinated index database
- subject string? (default ()) - A subject in the Subject's database
- publisher string? (default ()) - The name of a publisher in the Publisher's database
getISBNDBStatus![](/images/permalink.svg)
Gets status on the ISBNDB Database
getSubjectDetails![](/images/permalink.svg)
Gets subject details
Parameters
- name string - A subject in the Subject's database
searchSubject![](/images/permalink.svg)
Search subjects
Parameters
- query string - A string to search for in the Subject’s database
- pageSize string? (default ()) - How many items should be returned per page, maximum of 1,000
- page string? (default ()) - The number of page to retrieve, please note the API will not return more than 10,000 results no matter how you paginate them
Records![](/images/permalink.svg)
isbndb: ApiKeysConfig![](/images/permalink.svg)
Provides API key configurations needed when communicating with a remote HTTP endpoint.
Fields
- authorization string - All requests on the ISBNdb.com API needs to include an API key. The API key can be provided as part of the query string or as a request header. The name of the API key needs to be
Authorization
.
isbndb: Author![](/images/permalink.svg)
Describes the name of an author and the books written by that author in the database
Fields
- author string? - Author name
- books Book[]? - Detail about books written by author
isbndb: AuthorQueryResults![](/images/permalink.svg)
Describes the results of a query in the author's database
Fields
- total int? -
- authors string[]? -
isbndb: Book![](/images/permalink.svg)
Describes a book in the book's database
Fields
- title string? -
- title_long string? -
- isbn string? -
- isbn13 string? -
- dewey_decimal string? -
- binding string? -
- publisher string? -
- language string? -
- date_published string? -
- edition string? -
- pages int? -
- dimensions string? -
- overview string? -
- image CoverLink? - The link to the cover image
- msrp decimal? -
- excerpt string? -
- synopsys string? -
- authors string[]? -
- subjects string[]? -
- reviews string[]? -
- prices Merchant[]? - Only shows if the query param 'with_prices' is present.
- related BookRelated? -
isbndb: BookRelated![](/images/permalink.svg)
Fields
- 'type string? -
isbndb: BooksBody![](/images/permalink.svg)
Fields
- isbns string[] - a list of ISBN 10 or ISBN 13 in the Books database
isbndb: BooksBody1![](/images/permalink.svg)
Fields
- isbns string[] - a list of ISBN 10 or ISBN 13 in the Books database
isbndb: ClientHttp1Settings![](/images/permalink.svg)
Provides settings related to HTTP/1.x protocol.
Fields
- keepAlive KeepAlive(default http:KEEPALIVE_AUTO) - Specifies whether to reuse a connection for multiple requests
- chunking Chunking(default http:CHUNKING_AUTO) - The chunking behaviour of the request
- proxy ProxyConfig? - Proxy server related options
isbndb: ConnectionConfig![](/images/permalink.svg)
Provides a set of configurations for controlling the behaviours when communicating with a remote HTTP endpoint.
Fields
- httpVersion HttpVersion(default http:HTTP_2_0) - The HTTP version understood by the client
- http1Settings ClientHttp1Settings? - Configurations related to HTTP/1.x protocol
- http2Settings ClientHttp2Settings? - Configurations related to HTTP/2 protocol
- timeout decimal(default 60) - The maximum time to wait (in seconds) for a response before closing the connection
- forwarded string(default "disable") - The choice of setting
forwarded
/x-forwarded
header
- poolConfig PoolConfiguration? - Configurations associated with request pooling
- cache CacheConfig? - HTTP caching related configurations
- compression Compression(default http:COMPRESSION_AUTO) - Specifies the way of handling compression (
accept-encoding
) header
- circuitBreaker CircuitBreakerConfig? - Configurations associated with the behaviour of the Circuit Breaker
- retryConfig RetryConfig? - Configurations associated with retrying
- responseLimits ResponseLimitConfigs? - Configurations associated with inbound response size limits
- secureSocket ClientSecureSocket? - SSL/TLS-related options
- proxy ProxyConfig? - Proxy server related options
- validation boolean(default true) - Enables the inbound payload validation functionality which provided by the constraint package. Enabled by default
isbndb: Merchant![](/images/permalink.svg)
Describe the conditions of the price by merchant. Only with the Pro plan
Fields
- condition string? -
- merchant string? -
- merchant_logo string? -
- merchant_logo_offset MerchantMerchantLogoOffset? -
- shipping string? -
- price string? -
- total string? -
- link string? -
isbndb: MerchantMerchantLogoOffset![](/images/permalink.svg)
Fields
- x string? - Merchant logo x-offset
- y string? - Merchant logo y-offset
isbndb: ProxyConfig![](/images/permalink.svg)
Proxy server configurations to be used with the HTTP client endpoint.
Fields
- host string(default "") - Host name of the proxy server
- port int(default 0) - Proxy server port
- userName string(default "") - Proxy server username
- password string(default "") - Proxy server password
isbndb: Publisher![](/images/permalink.svg)
Describes about book publisher details
Fields
- name string? - Name of book publisher
- books PublisherBooks[]? - Details of books published
isbndb: PublisherBooks![](/images/permalink.svg)
Details of books published
Fields
- isbn string? -
isbndb: Subject![](/images/permalink.svg)
Describes about what the book is about
Fields
- subject string? -
- parent string? -
String types![](/images/permalink.svg)
isbndb: CoverLink![](/images/permalink.svg)
CoverLink
The link to the cover image
Import
import ballerinax/isbndb;
Metadata
Released date: about 1 year ago
Version: 1.5.1
License: Apache-2.0
Compatibility
Platform: any
Ballerina version: 2201.4.1
GraalVM compatible: Yes
Pull count
Total: 0
Current verison: 0
Weekly downloads
Keywords
Lifestyle & Entertainment/Books
Cost/Paid
Contributors
Dependencies