Skip to content

Commit

Permalink
Add legacy docs
Browse files Browse the repository at this point in the history
  • Loading branch information
maetthu committed Aug 16, 2024
1 parent 9a0cf55 commit cf698e2
Showing 1 changed file with 33 additions and 1 deletion.
34 changes: 33 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1 +1,33 @@
# iframely-server
# iframely-server

[![build](https://github.com/emgag/iframely-server/actions/workflows/build.yml/badge.svg)](https://github.com/emgag/iframely-server/actions/workflows/build.yml)
[![release](https://github.com/emgag/iframely-server/actions/workflows/release.yml/badge.svg)](https://github.com/emgag/iframely-server/actions/workflows/release.yml)

Simple wrapper for iframely oEmbed API.

## Endpoints

### _/info_

**Parameters**:

- (required) _api_key_: The API key for authentication
- (required) _url_: The url of the requested embed

**Response**:

A JSON object with the following values:

- _provider_: The lowercase embed provider name
- _url_: The requested embed url
- _html_: The embed html code
- _image_: The embed (preview) image

or

- _error_: In case of an error returned by iframely

## Environment variables

- `SERVER_API_KEY`: Key to authenticate clients
- `IFRAMELY_API_KEY`: API key for fetching data from iframely

0 comments on commit cf698e2

Please sign in to comment.