https://github.com/motdotla/carte
API of memory cards
https://github.com/motdotla/carte
Last synced: 7 months ago
JSON representation
API of memory cards
- Host: GitHub
- URL: https://github.com/motdotla/carte
- Owner: motdotla
- Created: 2014-06-28T02:16:56.000Z (over 11 years ago)
- Default Branch: master
- Last Pushed: 2014-07-07T23:14:09.000Z (over 11 years ago)
- Last Synced: 2025-01-24T05:09:36.227Z (9 months ago)
- Language: Go
- Size: 332 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# carte
API of memory cards. I'm beginning this with people in my company.
## Usage
```
git clone https://github.com/scottmotte/carte.git
cd carte
```
Then run [srvdir](https://srvdir.net/) and visit the url.
```
srvdir
```
## Data Scraping
### From Parklet
[Parklet](http://parklet.co) might be where you check your employee directory. Here's how to scrape all their photos and names with js.
Visit the [directory](https://app.parklet.co/directory), go to the view that has the smaller pictures, load everyone, and then open Chrome console.
Paste the following in.
```javascript
var results = []; var uri_pattern = /\b((?:[a-z][\w-]+:(?:\/{1,3}|[a-z0-9%])|www\d{0,3}[.]|[a-z0-9.\-]+[.][a-z]{2,4}\/)(?:[^\s()<>]+|\(([^\s()<>]+|(\([^\s()<>]+\)))*\))+(?:\(([^\s()<>]+|(\([^\s()<>]+\)))*\)|[^\s`!()\[\]{};:'".,<>?«»“”‘’]))/ig; $item = $(".value-items .value-item"); $item.each(function() { var style = $( this ).find(".employee").attr("style"); var matches = style.match(uri_pattern); var name = $(this).find("span[name='name']").text(); if (matches) { results.push({front: "
", back: name, tags: ["sendgrid"] });} }); var str = JSON.stringify(results, undefined, 2); console.log(str); $("body").append(str);
```
Scroll to the bottom of the screen and double click the newly appended content.
Paste that json content into [here](http://jsonformat.com/).
Copy the results. Paste those results in cards.json.
## API Overview
The [carte.herokuapp.com](https://carte.herokuapp.com) API is based around REST. It uses standard HTTP authentication. JSON is returned in all responses from the API, including errors.
I've tried to make it as easy to use as possible, but if you have any feedback please [let me know](mailto:scott@scottmotte.com).
## Summary
### API Endpoint
* [https://carte-api.herokuapp.com/api/v0](https://carte-api.herokuapp.com/api/v0)
### Accounts
To start using the carte API, you must first create a deck.
#### ANY /accounts/create
Pass an email to create your account at carte-api.herokuapp.com.
##### Definition
```
ANY https://carte-api.herokuapp.com/api/v0/accounts/create.json?&email=[email]&api_key=[api_key]
```
##### Required Parameters
* email
##### Optional Parameters
* api_key
##### Example Request
##### Example Response
```
{
"accounts": [{
"email": "test@example.com",
"api_key": "the_default_generated_api_key_that_you_should_keep_secret"
}]
}
```
##### Example Error
```
{
errors: [{
"code": "required",
"field": "email",
"message": "email cannot be blank"
}]
}
```
#### ANY /cards/create
Pass an api_key, front, and back to create your card.
##### Definition
```
ANY https://carte-api.herokuapp.com/api/v0/cards/create.json?api_key=[api_key]&front=[front]&back=[back]
```
##### Required Parameters
* api_key
* front
* back
##### Example Request
##### Example Response
```
{
"cards": [{
"id": "12345",
"front": "
",
"back": "John Doe",
}]
}
```
##### Example Error
```
{
errors: [{
"code": "required",
"field": "front",
"message": "front cannot be blank"
}]
}
```